Documentation

We are using MkDocs for this documentation site.

Commands

• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.
• mkdocs gh-deploy -v --force - Deploy to GitHub Pages.

You might see this error when you try to execute those commands:

$ mkdocs
Command 'mkdocs' not found, but can be installed with:
sudo apt install mkdocs

You can install it with: poetry install and run it via Poetry:

poetry run mkdocs serve
poetry run mkdocs ...
poetry run mkdocs OPTION

Project layout

    mkdocs.yml    # The configuration file.
    docs/
        index.md  # The documentation homepage.
        ...       # Other markdown pages, images and other files.