The documentation is generated automatically generated on every change from the docs folder.
This approach uses MkDocs to generate static html files out of markdown files.
We use the template Material for MkDocs for visualization.
The generated Website is hosted as GitHub Page directly with this project.
Changes to documentation on the main branch in the /docs folder will generate and deploy the documentation automatically.
Configuration is done inside mkdocs.yml file.
All template related configurations are done inside the template.yml file.
- Install Python
- Clone this repository
- Run
pip install --upgrade -r requirements.txt(might need administrator rights) - Run
mkdocs serve - Access http://localhost:8000 in browser
- Any change will reload the browser automatically
- Run
pip install --upgrade -r requirements.txtagain (might need administrator rights)