Metadata-Version: 2.4
Name: mkdocs-materialx
Version: 10.0.2
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
Author-email: Aaron Wang <aaronwqt@gmail.com>
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.8
Requires-Dist: babel>=2.10
Requires-Dist: backrefs>=5.7.post1
Requires-Dist: colorama>=0.4
Requires-Dist: jinja2>=3.1
Requires-Dist: markdown>=3.2
Requires-Dist: mkdocs-material-extensions>=1.3
Requires-Dist: mkdocs>=1.6
Requires-Dist: paginate>=0.5
Requires-Dist: pygments>=2.16
Requires-Dist: pymdown-extensions>=10.2
Requires-Dist: requests>=2.26
Provides-Extra: git
Requires-Dist: mkdocs-document-dates>=3.5; extra == 'git'
Requires-Dist: mkdocs-git-committers-plugin-2<3,>=1.1; extra == 'git'
Provides-Extra: imaging
Requires-Dist: cairosvg~=2.6; extra == 'imaging'
Requires-Dist: pillow<12.0,>=10.2; extra == 'imaging'
Provides-Extra: recommended
Requires-Dist: mkdocs-minify-plugin~=0.7; extra == 'recommended'
Requires-Dist: mkdocs-redirects~=1.2; extra == 'recommended'
Requires-Dist: mkdocs-rss-plugin~=1.6; extra == 'recommended'
Description-Content-Type: text/markdown

<h2 style="text-align: center;margin-bottom: 1.5rem;"><span style="color:#449798">MaterialX</span> for MkDocs</h2>

<p align="center">
<strong>MaterialX</strong>, the next generation of mkdocs-material, is based on material v9.7.0 and is continuously maintained by individual developers (since mkdocs-material will cease maintenance) to keep the mkdocs ecosystem alive!
</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" />
  </a>
</p>


## Quick start

<span style="color:#449798">MaterialX</span> for MkDocs can be installed with `pip`:

``` sh
pip install mkdocs-materialx
```

Add the following lines to `mkdocs.yml`:

``` yaml
theme:
  name: materialx
```

> [!NOTE]
> The theme is `materialx`, not material. Everything else is the same as when using material.

<br />

For detailed installation instructions, configuration options, and a demo, visit [squidfunk.github.io/mkdocs-material](https://squidfunk.github.io/mkdocs-material/)