Skip to content

Documentation Site Template Features

MkDocs and Material

  • Material for MkDocs theme (tabs, search, admonitions, content actions)
  • Full-text search with configurable separator
  • Mermaid diagrams via pymdownx.superfences (no separate mkdocs-mermaid2-plugin required)
  • mkdocs-panzoom-plugin for zoom on Mermaid and images
  • mkdocs-exclude to omit paths such as build.md from the site

Content and structure

  • Starter pages: Home, Architecture, Use Cases, API Reference stub, Tutorials / Getting Started
  • docs/includes/ for shared snippets (see pymdownx.snippets in mkdocs.yml)
  • Sample ADR under docs/adr/ plus log4brains (.log4brains.yml, npm scripts in package.json)

Branding and metadata

Template parameters replace siteTitle, siteDescription, repoUrl, and the copyright line (year via currentYear replacing the 1975 placeholder). See Parameters.

CI/CD and hosting

  • Sample Azure DevOps pipeline: build MkDocs, build ADRs, merge ADR output into the static site, publish artifact
  • staticwebapp.config.json for Azure Static Web Apps (routes and security can be customized)

Python dependencies

Install from the generated requirements.txt (Material, panzoom plugin, exclude plugin). The template repository README documents this explicitly.