Metadata-Version: 2.5
Name: mkdocs-material
Version: 9.8.0
Summary: Documentation that simply works
Project-URL: Documentation, https://squidfunk.github.io/mkdocs-material/
Project-URL: Source, https://github.com/squidfunk/mkdocs-material
Project-URL: Changelog, https://squidfunk.github.io/mkdocs-material/changelog/
Project-URL: Issues, https://github.com/squidfunk/mkdocs-material/issues
Project-URL: Maintenance, https://zensical.org/upcoming-changes/#material-for-mkdocs
Project-URL: Migration, https://zensical.org/docs/compatibility/mkdocs/migration/
Author-email: Martin Donath <martin.donath@squidfunk.com>
License-Expression: MIT
License-File: LICENSE
Keywords: documentation,mkdocs,theme
Classifier: Development Status :: 7 - Inactive
Classifier: Environment :: Web Environment
Classifier: Framework :: MkDocs
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Python: >=3.11
Requires-Dist: babel>=2.10
Requires-Dist: backrefs>=5.7.post1
Requires-Dist: colorama>=0.4
Requires-Dist: jinja2>=3.1.6
Requires-Dist: markdown>=3.8.1
Requires-Dist: mkdocs-material-extensions>=1.3
Requires-Dist: mkdocs<2,>=1.6
Requires-Dist: paginate>=0.5
Requires-Dist: pygments>=2.20.0
Requires-Dist: pymdown-extensions>=11.0.1
Requires-Dist: requests>=2.33.0
Provides-Extra: git
Requires-Dist: gitpython>=3.2.1; extra == 'git'
Requires-Dist: mkdocs-git-committers-plugin-2>=1.1; extra == 'git'
Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.2.4; extra == 'git'
Provides-Extra: imaging
Requires-Dist: cairosvg>=2.9.1; extra == 'imaging'
Requires-Dist: pillow>=13.0.0; extra == 'imaging'
Provides-Extra: recommended
Requires-Dist: mkdocs-minify-plugin>=0.7; extra == 'recommended'
Description-Content-Type: text/markdown

<p align="center">
  <a href="https://squidfunk.github.io/mkdocs-material/">
    <img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.svg" width="320" alt="Material for MkDocs">
  </a>
</p>

<p align="center">
  <strong>
    A powerful documentation framework on top of
    <a href="https://www.mkdocs.org/">MkDocs</a>
  </strong>
</p>

<p align="center">
  <a href="https://github.com/squidfunk/mkdocs-material/actions"><img
    src="https://github.com/squidfunk/mkdocs-material/workflows/build/badge.svg"
    alt="Build"
  /></a>
  <a href="https://pypistats.org/packages/mkdocs-material"><img
    src="https://img.shields.io/pypi/dm/mkdocs-material.svg"
    alt="Downloads"
  /></a>
  <a href="https://pypi.org/project/mkdocs-material"><img
    src="https://img.shields.io/pypi/v/mkdocs-material.svg"
    alt="Python Package Index"
  /></a>
  <a href="https://hub.docker.com/r/squidfunk/mkdocs-material/"><img
    src="https://img.shields.io/docker/pulls/squidfunk/mkdocs-material"
    alt="Docker Pulls"
  /></a>
</p>

<p align="center">
  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.
</p>

<p align="center">
  <a href="https://squidfunk.github.io/mkdocs-material/getting-started/">
    <img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/screenshot.png" width="700" alt="Material for MkDocs documentation site" />
  </a>
</p>

---

> [!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](https://zensical.org/), 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. The `classic` theme variant preserves the
> appearance of Material for MkDocs. See the
> [migration guide](https://zensical.org/docs/compatibility/mkdocs/migration/)
> for the steps and current compatibility details.
> 
> [Upcoming changes on November 5](https://zensical.org/upcoming-changes/)

## Quick start

Material for MkDocs requires Python 3.11 or newer. Install it with `pip`:

``` sh
pip install mkdocs-material
```

Add the following lines to `mkdocs.yml`:

``` yaml
theme:
  name: material
```

See the [installation guide](https://squidfunk.github.io/mkdocs-material/getting-started/)
for detailed instructions and the
[documentation](https://squidfunk.github.io/mkdocs-material/)
for configuration options.

## Used by

Material for MkDocs has been used by projects including
[FastAPI](https://fastapi.tiangolo.com/),
[Pydantic](https://pydantic-docs.helpmanual.io/),
[Ruff](https://docs.astral.sh/ruff/),
[OpenSSL](https://docs.openssl.org/),
[AWS Copilot](https://aws.github.io/copilot-cli/), and
[Google Accompanist](https://google.github.io/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.
