MkDocs Overview

The MkDocs guide section is a reference for using MkDocs and Material for MkDocs.

Note

This site is hosted with GitHub Pages using Material for MkDocs. The frontmatter is used for YAML style meta-data.

Placeholder page for MkDocs guides

Note

This page is missing content so this placeholder section is here until content is added.

Note

Read through the MkDocs "Writing your docs" guide and the Material for MkDocs "Reference" guide for more information about using Material for MkDocs.

Local install

Warning

As mentioned in the Material for MkDocs "getting started with docker" guide, the Docker container is intended for local previewing purposes only and is not suitable for deployment. This is because the web server used by MkDocs for live previews is not designed for production use and may have security vulnerabilities.

The local install guide contains the recommended steps to run MkDocs locally.