Hummingbot Foundation website and documentation

Welcome to the official website and documentation for Hummingbot and the Hummingbot Foundation!

Install and Run

This documentation site uses MkDocs documentation-focused static site engine, along with Material for MkDocs theme, of which Hummingbot is a proud sponsor.

Insiders

The deployed site at https://hummingbot.org uses the Insiders build of , which features experimental features like tags and social cards. For Hummingbot site editors, see below for how to deploy the site in your local development environment and Netlify:

# change to conda base environment since there may be conflicts with other environments like hummingbot
➜ conda activate

# install mkdocs-material-insiders and dependencies (HTTPS)
(base) ➜ pip install git+https://github.com/CoinAlpha/mkdocs-material-insiders.git

# install mkdocs-material-insiders and dependencies (SSH)
(base) ➜ pip install git+ssh://git@github.com/CoinAlpha/mkdocs-material-insiders

# install revision date plugin
(base) ➜ pip install mkdocs-git-revision-date-plugin

# build Markdown files into HTML and start local development server
(base) ➜ mkdocs serve

Regular

You can also generate the site using the normal version of Material for MkDocs:

# change to conda base environment since there may be conflicts with other environments like hummingbot
➜ conda activate

# install mkdocs-material and dependencies (HTTPS)
(base) ➜ pip install git+https://github.com/squidfunk/mkdocs-material.git

# install mkdocs-material-insiders and dependencies (SSH)
(base) ➜ pip install git+ssh://git@github.com/squidfunk/mkdocs-material

# install revision date plugin
(base) ➜ pip install mkdocs-git-revision-date-plugin

# build Markdown files into HTML and start local development server
(base) ➜ mkdocs serve

Deployment

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 to use the Insiders build.

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

Contributions

We welcome contributions to the Hummingbot documentation 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!