Skip to content

Latest commit

 

History

History
 
 

documentation

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

hummingbot-docs

Docs for hummingbot, the open source crypto market making bot

Read the contribution guidelines before you proceed to edit the documentation.

Prequisites: MKdocs is required before you can edit the docs, go to MKdocs for details.

For Mac users By default, MacOS ships with Python-2, you need to change it to Python3, see Linkfor details.

Dependencies

After MKDocs have been installed, navigate to Hummingbot>Documentation folder and run the following dependencies:

pip install -r requirements.txt

Develop

Run the following command to build Hummingbot Markdown files into HTML and starts a development server to browse the documentation.

mkdocs serve

Go to http://localhost:8000

Build

After editing, run the following command to build the documentation,

mkdocs build