This is an example in how to create a documentation website for a project using a containerized MkDocs.
The container contains a couple MkDocs Plugins:
- mkdocs-minify-plugin
- mkdocstrings (For Python and Shell Code)
- mkdocs-render-swagger-plugin
These plugins allow displaying Code via Docstrings and Swagger within the documentation website.
The used example Python Code can be found here
The Swagger example source can be found here.
There are also some examples for options that can be added in the mkdocs.yml file.
docker run -it --rm -d --name mkdocs -p 8000:8000 -v ${PWD}/project:/project mkdocs- MkDocs only recognize 4 Spaces indentation and not 2
- Braking changes in the Markdown Files may make the Container crash