Skip to main content

Material for MkDocs

A powerful documentation framework on top of MkDocs

Build Downloads Python Package Index Docker Pulls

Write your documentation in Markdown and create a professional static site for your Open Source or commercial project in minutes – searchable, customizable, more than 60 languages, for all devices.

Material for MkDocs documentation site


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.

Metadata

Release files for mkdocs-material 9.8.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-material 9.8.2
File Size Uploaded Provenance Actions
mkdocs_material-9.8.2.tar.gz 4.2 MB With provenance Details for mkdocs_material-9.8.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-material 9.8.2
File Interpreter ABI Platform Actions
mkdocs_material-9.8.2-py3-none-any.whl Python 3 none any Details for mkdocs_material-9.8.2-py3-none-any.whl

Total release size: 13.5 MB

Release files / mkdocs_material-9.8.2.tar.gz

Download URL mkdocs_material-9.8.2.tar.gz
Size 4.2 MB
Tags Source
SHA-256 checksum
How to use checksums
005d942bdbfa22efa049f4818c31d42fb36bed6d362adb641dd7a2e948078f9d
BLAKE2b-256 checksum
How to use checksums
99bfc47389fa622b513c2d115eb4c16075ef04a5f4d8156039f46cb26e5c70a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.

Transparency log

Release files / mkdocs_material-9.8.2-py3-none-any.whl

Download URL mkdocs_material-9.8.2-py3-none-any.whl
Size 9.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
ef1414cab33d64fcc13387e972af5ba4620f55f93482d1842933399ed2c69b02
BLAKE2b-256 checksum
How to use checksums
18869204441dd9e224f1dc3f1a32edf6a474e84696bfa493c7df067dcde36366
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.

Transparency log

Security for mkdocs-material 9.8.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for mkdocs_material-9.8.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

9.8.2 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page