Documentation ¶
Configuration
- Main config file:
mkdocs.yml - Additional dependencies:
docs/requirements.txt - Installation:
Dockerfile - Service definition:
compose.yml
Introduction ¶
The devcontainer includes a system for building project documentation, useful for developing and publishing a full-featured documentation website, either as a standalone entity or as part of a software library/project.
Documenation is written in plaintext files using the popular Markdown syntax.
Besides being widely supported and straightfowrad to edit in a variety of platforms, documentation written as Markdown is
easily versioned by systems like git.
The Python-based mkdocs tool builds Markdown documentation files into a website structure.
Themeing and additional documentation content functionality are provided by the
mkdocs-material extension.
Features ¶
- Complete color themes for both light and dark modes
- Google Analytics support (with a
G-xxxxxxxxxxconfiguration) - Site search
- Icons from
FontAwesome - Diagram support via Mermaid.js
- Better site navigation with
awesome-pages - Redirect old URLs when content moves around with
redirects
See the mkdocs-material Reference for more supported features.