Material for MkDocs
Documentation framework on top of MkDocs that builds static documentation sites from Markdown.
squidfunk.github.io/mkdocs-material/repositorydocs
Material for MkDocs is a documentation framework built on MkDocs, a static site generator for project documentation. It turns a directory of Markdown files and a configuration file into a static documentation site, with search that runs in the visitor’s browser, code annotations and generated social cards. The package is installed with pip, and an official Docker image is provided for local previewing only. The publishing guide describes building the site and deploying it to GitHub Pages or GitLab Pages. Martin Donath maintains the project.
Worth knowing
The project is in maintenance mode. Critical maintenance continues through May 5, 2027, and the project names Zensical as its successor.
Identity
- Status
- Active
- Maintainer
- Martin Donath3
- Maintained by
- Individual
- First release
- 20168
Rendering and deploy
- Runs as
- Static files, Dev only6
- Rendering
- Static output6
- Install with
- pip, docker, git4
Releases
Adoption
Sources
- 2026-10-23: links, Written in, License, GitHub stars
api.github.com/repos/squidfunk/mkdocs-material - 2026-10-23: links, License
squidfunk.github.io/mkdocs-material/ - 2026-10-23: Maintainer
github.com/squidfunk/mkdocs-material/blob/master/LICENSE - 2026-10-23: Categories, Runtime, Install with, links, Built on
squidfunk.github.io/mkdocs-material/getting-started/ - 2026-10-23: Minimum runtime
pypi.org/pypi/mkdocs-material/json - 2026-10-23: Rendering, Content storage, Runs as
squidfunk.github.io/mkdocs-material/creating-your-site/ - 2026-10-23: Contributors
api.github.com/repos/squidfunk/mkdocs-material/contributors - 2026-10-23: First release, Current major version
api.github.com/repos/squidfunk/mkdocs-material/releases - 2026-10-23: Last release
api.github.com/repos/squidfunk/mkdocs-material/releases/latest - 2026-10-23: Multilingual
github.com/squidfunk/mkdocs-material/blob/master/README.md - 2026-10-25: Dependent repositories, Dependent packages, Downloads a month
packages.ecosyste.ms/api/v1/registries/pypi.org/packages/mkdocs-material