Skip to content

Latest commit

 

History

History
18 lines (11 loc) · 518 Bytes

documentation.md

File metadata and controls

18 lines (11 loc) · 518 Bytes

Documentation

The documentation is written using MkDocs and hosted on GitHub Pages. It also uses Material for MkDocs for the general theming of the docs site.

Contributing

  1. To edit the documentation it you'll need Python

  2. Install mkdocs-material with: pip install mkdocs-material

  3. Running the documentation locally

    > mkdocs serve
  4. The documentation automatically builds and deploys to GitHub Pages when you push to the main branch.