WHEN: Creating, configuring, or deploying MkDocs documentation sites. Working with mkdocs.yml, Material theme, plugins (mkdocstrings, gen-files, literate-nav, mermaid2), or CI/CD for docs. WHEN NOT: Non-MkDocs static site generators (Sphinx, Docusaurus, Hugo).
Comprehensive guide for building documentation sites with MkDocs and Material for MkDocs theme. Covers CLI usage, configuration, theming, plugins, and deployment.
# Create and serve a new project
pip install mkdocs-material
mkdocs new my-docs && cd my-docs
mkdocs serve # http://127.0.0.1:8000
Minimal mkdocs.yml:
site_name: My Documentation