MkDocs Material
A documentation framework powered by MkDocs with the Material theme. Write your docs in Markdown and get a polished, searchable static site out of the box.
What You Can Do After Deployment
- Visit your domain — a sample MkDocs site is served immediately
- Mount your docs — add your Markdown files and
mkdocs.yml config via a volume or custom image
- Live preview — the built-in dev server reloads on file changes
- Search works instantly — client-side search is included with no extra setup
Key Features
- Material Design — clean, responsive layout with dark/light mode toggle
- Navigation — tabs, sections, table of contents, back-to-top button
- Search — instant client-side search with highlighting
- Code Blocks — syntax highlighting for 300+ languages, copy button, annotations
- Admonitions — note, warning, tip, danger callout boxes
- Diagrams — Mermaid.js integration for flowcharts and sequence diagrams
- Versioning — mike integration for multi-version docs
- Blog — built-in blog plugin for changelogs and announcements
License
MIT — GitHub