Skip to content

Wiki setup

Install MkDocs

1
pip install mkdocs

Plugin to open images on the same page by zooming it: 

1
pip install mkdocs-glightbox

To compile live on save 

1
mkdocs serve

Versioning

Consistency is TBD. 

1
2
3
4
5
pip install mike

# make sure the default alias is 'latest'
mike deploy --push --update-aliases 0.0.0 latest
mike set-default --push latest

Guidelines

Even though mkdocs is pure markdown, there are many extensions and plugins included. For the ones used here, refer to mkdocs.yml. Furthermore, reference MkDocs Setup and Reference.

API Template

Refer to API_template.md for the API structure.