# Docs README

serve (dev only)
```bash
mkdocs serve
```

# gh-pages

```bash
mkdocs gh-deploy
```

## Notes

* pdf build is possible, but takes a very long time, commented for now
* deploy onto github pages
    - https://www.mkdocs.org/user-guide/deploying-your-docs/
* mike can be used to deploy multiple versions of project documentation with mkdocs
    - https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/