Documentation Template

This is a template for a documentation using mkdocs and material.

Install

pip install mkdocs-material pymdown-extensions pygments

Run

Serve the documentation on a local port:
- mkdocs serve
- open http://localhost:8000
Generate static html from the documentation:
- mkdocs build
- useful for backups or sharing

Documentation

Basic documentation mkdocs.org.
Useful documentation material
Advanced extensions PyMdown Extension