Merge branch 'main' into doc/add-staging-bug-hunt
tree: 67ea7239bc5e1832a435f852726ff55c9dee3848
  1. docs/
  2. includes/
  3. .gitignore
  4. _redirects
  5. LICENSE
  6. mkdocs.yml
  7. netlify.toml
  8. package-lock.json
  9. package.json
  10. README.md
  11. runtime.txt
README.md

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.

!!! note "Cairo dependency" Since we recently added social cards, you may need to install the Cairo graphics library to run this locally. On macOS, you can install it globally using Homebrew with brew install cairo.

Insiders

The deployed site at https://hummingbot.org uses the Insiders build of MkDocs-Material, which features experimental features like tags and social cards. For site editors, please request access to the CoinAlpha fork of the Insiders repo, so that you can deploy the site in your local development environment and Netlify.

# create new conda environment
(base) ➜ conda create -n mkdocs-material

# activate new environment
(base) ➜ conda activate mkdocs-material

# install pip
(mkdocs-material) ➜ conda install pip

# install mkdocs-material-insiders and dependencies
# (http)
(mkdocs-material) ➜ pip install git+https://github.com/CoinAlpha/mkdocs-material-insiders.git
# (ssh)
(mkdocs-material) ➜ 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!