Documentation

Documentation is written in mkdocs and there are a few extensions that allow richer authoring than markdown.

To iterate with documentation, therefore, it is recommended to run the mkdocs server and view your pages in a browser.

Prerequisites

If you have nix installed, you can:

nix develop .#docs

To drop into a shell with all the needed dependencies.

cd ./www
docker build -t material-mkdocs
docker run --rm -it -p 8000:8000 -v .:/docs material

After installing mkdocs and extensions, build and run the documentation locally:

task docs:serve

The site will soon be available at http://localhost:8000 and auto-update after changes.