Metadata-Version: 2.5
Name: mkdocs-ng-material
Version: 9.8.0
Summary: Material for MkDocs, maintained for MkDocs NG
Project-URL: Homepage, https://mkdocs-ng.github.io/mkdocs-material/
Project-URL: Bug Tracker, https://github.com/mkdocs-ng/mkdocs-material/issues
Project-URL: Repository, https://github.com/mkdocs-ng/mkdocs-material.git
Author: Martin Donath
License-Expression: MIT
License-File: LICENSE
Keywords: documentation,mkdocs,theme
Classifier: Development Status :: 5 - Production/Stable
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.10
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-ng<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'
Requires-Dist: mkdocs-redirects>=1.2; extra == 'recommended'
Description-Content-Type: text/markdown

<p align="center">
  <a href="https://mkdocs-ng.github.io/mkdocs-material/">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/mkdocs-ng/.github/main/assets/mkdocs-ng-logo-dark.svg">
      <img src="https://raw.githubusercontent.com/mkdocs-ng/.github/main/assets/mkdocs-ng-logo.svg" width="120" alt="MkDocs NG">
    </picture>
  </a>
</p>

<h1 align="center">MkDocs NG Material</h1>

<p align="center">
  <strong>
    Material for MkDocs, maintained for
    <a href="https://github.com/mkdocs-ng/mkdocs">MkDocs NG</a>
  </strong>
</p>

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

MkDocs NG Material is a community-maintained fork of [Material for MkDocs] by
Martin Donath, published on PyPI as `mkdocs-ng-material` and part of the
[MkDocs NG] project. It exists so that sites built on MkDocs keep getting
security and bug fixes.

How it differs from upstream:

- **Security, bug and compatibility fixes.** Upstream fixes are ported as
  they are released; there are no new features of its own.
- **Installs alongside upstream.** The theme lives in its own package, so it
  does not clash with `mkdocs-material` when a plugin pulls that in.
- **Built on MkDocs NG.** It depends on `mkdocs-ng` and requires Python 3.10
  or newer.
- `mkdocs-redirects` stays in the `[recommended]` extra.

Everything else, including configuration and the `material` theme name, is the
same as upstream, so switching is a one-line change in your requirements.

  [Material for MkDocs]: https://github.com/squidfunk/mkdocs-material
  [MkDocs NG]: https://github.com/mkdocs-ng

## Everything you would expect

### It's just Markdown

Focus on the content of your documentation and create a professional static site
in minutes. No need to know HTML, CSS or JavaScript – let Material for MkDocs do
the heavy lifting for you.

### Works on all devices

Serve your documentation with confidence – Material for MkDocs automatically
adapts to perfectly fit the available screen estate, no matter the type or size
of the viewing device. Desktop. Tablet. Mobile. All great.

### Made to measure

Make it yours – change the colors, fonts, language, icons, logo, and more with
a few lines of configuration. Material for MkDocs can be easily extended and
provides many options to alter appearance and behavior.

### Fast and lightweight

Don't let your users wait – get incredible value with a small footprint by using
one of the fastest themes available with excellent performance, yielding optimal
search engine rankings and happy users that return.

### Maintain ownership

Own your documentation's complete sources and outputs, guaranteeing both
integrity and security – no need to entrust the backbone of your product
knowledge to third-party platforms. Retain full control.

### Open Source

You're in good company – choose a mature and actively maintained solution built
with state-of-the-art Open Source technologies, used by tens of thousands of
projects. Licensed under MIT.

## Quick start

MkDocs NG Material can be installed with `pip`:

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

Add the following lines to `mkdocs.yml`:

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

For detailed installation instructions, configuration options, and a demo, visit
[mkdocs-ng.github.io/mkdocs-material][docs]

  [docs]: https://mkdocs-ng.github.io/mkdocs-material/
  [Material for MkDocs]: https://github.com/squidfunk/mkdocs-material

## License

MkDocs NG Material is a community-maintained fork of Material for MkDocs.

**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.
