MkDocs

MkDocs is a static site generator that uses Markdown files (and many other formats) to create a website.

This handbook is built using MkDocs and Material for MkDocs. These tools also have extensive documentation and guides for contributing to a Mkdocs project.

Note

For a basic tutorial on Markdown, see the Markdown page.

Funamentally, any standard Markdown file is valid for MkDocs, however, there are some additional features that can be used to enhance the look and feel of your documentation.

Material for MkDocs

Material for MkDocs is a theme for MkDocs that provides a modern and customizable look and feel.

It provides an easy-to-use interface for creating documentation.

Visit the Material for MkDocs Formatting page for more information on adding extra flavor to your Markdown files.