Development¶

This project uses Task as a command runner. The Taskfile.yaml at the root of the project contains all the available commands.

Documentation¶

The documentation is built using MkDocs with the Material for MkDocs theme.

Dependencies¶

To install the documentation dependencies, run the following command:

task docs-deps

pipx install mkdocs
pipx install mkdocs-material
pipx install pymdown-extensions

Local Development Server¶

To start a local development server that automatically reloads when you make changes, run:

task serve

 docker run --rm -it -p 8000:8000 -v ${PWD}:/docs \
    --platform linux/amd64 nicholaswilde/mkdocs-material serve \
    --dev-addr 0.0.0.0:8000 -f ./mkdocs.yml

This will make the documentation available at http://localhost:8000.

Deployment¶

To deploy the documentation to GitHub Pages, run:

task docs-deploy

mkdocs gh-deploy --force