mkdocs-material

<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