mkdocs-material
From public sourcesMaterial for MkDocs is an open-source theme and framework for MkDocs that turns Markdown files into a searchable, responsive static documentation site.
Overview
- documentation
- framework
- knowledge-base
- material-design
- mkdocs
- plugins
- theme
Installation
Commands are shown, never run by the marketplace. Check them against the official documentation.- Official websiteFrom public sourcesfrom catalog metadatasquidfunk.github.io/mkdocs-material/ ↗
- Language package registrypythonFrom public sourcesfrom the package manifest — publication on the registry is not verified
pipx install mkdocs-materialNot verified: check that this package in the registry belongs to this project before installing.
pypi.org/project/mkdocs-material/ ↗ - Build from sourceFrom public sourcesfrom catalog metadata
Build from source: no validated build recipe — follow the repository instructions.
github.com/squidfunk/mkdocs-material ↗
Compatibility
Unknown means no evidence was found — not that the product is incompatible.| Platform | Status | Architecture | Evidence | Confidence |
|---|---|---|---|---|
| Windows | Unknown | — | — | — |
| macOS | Unknown | — | — | — |
| Linux | Unknown | — | — | — |
| Container (OCI) | Unknown | — | — | — |
| Web browser | Compatible | — | Declared on the card | — |
| Python | Compatible | — | package manifest: pyproject.toml name | 0.60 |
Releases
checked Oct 29, 2026Files in 9.8.0
This release has no attached files.
Release history
- v9.7.7Jul 17, 2026Official source ↗
- v9.7.6Mar 19, 2026Official source ↗
- v9.7.5Mar 10, 2026Official source ↗
- v9.7.4Mar 3, 2026Official source ↗
- v9.7.3Feb 24, 2026Official source ↗
- v9.7.2Feb 18, 2026Official source ↗
- v9.7.1Dec 18, 2025Official source ↗
Quality profile
algorithm quality-v1.0 · assessed Oct 15, 2026Score components
License
MITThis is the catalog policy status, not legal advice.
Sources
Reviews
No reviews yet.
Alternatives
mkdocsSimilar
docusaurusSimilar
docsifySimilar
vitepressSimilar
reflexSimilar
storybookSimilarREADME
From squidfunk/mkdocs-material · license MIT · fetched Oct 29, 2026[!WARNING]
Material for MkDocs reaches end of life on May 5, 2027. Critical fixes and security updates continue until that date.
We're continuing our work with Zensical, a maintained successor built by the team behind Material for MkDocs. It carries forward what we've learned from building documentation tools with this community, with Markdown authoring, a familiar design, and full control over your content. Zensical is Open Source and MIT-licensed.
You can evaluate Zensical alongside MkDocs using your existing
mkdocs.yml. Check plugin compatibility and compare your pages, navigation, search, and customizations before switching. Theclassictheme variant preserves the appearance of Material for MkDocs. See the migration guide for the steps and current compatibility details.
Quick start
Material for MkDocs requires Python 3.11 or newer. Install it with pip:
pip install mkdocs-material
Add the following lines to mkdocs.yml:
theme:
name: material
See the installation guide for detailed instructions and the documentation for configuration options.
Used by
Material for MkDocs has been used by projects including FastAPI, Pydantic, Ruff, OpenSSL, AWS Copilot, and Google Accompanist.
Acknowledgments
Thank you to everyone who sponsored Material for MkDocs. Your support made its development possible. We're grateful to the contributors, translators, and users who helped shape the project over the years.
License
MIT License
Copyright (c) 2016-2025 Martin Donath
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.