This documentation project is built using MkDocs.
For an automatically updating live preview in your browser, run mkdocs serve
To install the required dependencies, please run pip install -r requirements.txt
The following plugins for MkDocs are being used:
- https://squidfunk.github.io/mkdocs-material/
- https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
When contributing to this project, please refer to the Styleguide.
I know it's kinda long, but it will help in keeping the documentation consistent. You will also find examples of
when to use specific features of mkdocs and mkdocs-material.