The official documentation for Hummingbot

This documentation site uses the MkDocs documentation-focused static site engine, along with the Material for MkDocs theme.

The deployed site at https://docs.hummingbot.io uses the Insiders build of Material for MkDocs, which features experimental features like tags and social cards.

For internal Hummingbot staff, see below for how to deploy the site in your local development environment and Netlify:

# install mkdocs-material-insiders and dependencies
pip install git+https://github.com/CoinAlpha/mkdocs-material-insiders.git

# install revision date plugin
pip mkdocs-git-revision-date-plugin

The netlify.toml file in the root directory contains the instructions used by Netlify to build the site. Make sure to add the GH_TOKEN as a build environment variable in Netlify beforehand.

If you push your commits to the docs/staging branch, Netlify will automatically deploy that branch to a staging site.

From the /documentation, directory, run the following command to build Markdown files into HTML and start a development server to browse the documentation:

mkdocs serve

Afterwards, go to http://localhost:8000 in your web browser.

After editing, run the following command to build the documentation for deployment:

mkdocs build

We welcome contributions by our community!

Please create a new issue if there are areas of the documentation you would like us to improve, or submit a pull request with the proposed change!