Hummingbot website and documentation

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

Installation

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

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

  - pip:
    - git+ssh://[email protected]/hummingbot/mkdocs-material-insiders

Create and activate new hummingbot-site conda environment using the environment file:

conda env create -f environment.yml

For core site editors, please request access to the Insiders repo, so that you can deploy the site in your local development environment. You also comment out the following lines in environment.yml:

  - pip:
    - git+ssh://[email protected]/hummingbot/mkdocs-material-insiders

Activate the environment:

conda activate hummingbot-site

Run site locally at http://localhost:8000:

mkdocs serve

To run the site on a different port, such as 8080:

mkdocs serve --dev-addr=127.0.0.1:8080

Build site for production:

mkdocs build

Contributions

We welcome contributions to the Hummingbot documentation by our community! See Contributing for more information.

To suggest changes, please create a new issue or submit a pull request with the proposed change!