Metadata-Version: 2.4
Name: mkdocs-materialx
Version: 10.0.4
Summary: Documentation that simply works
Project-URL: Homepage, https://github.com/jaywhj/mkdocs-materialx
Project-URL: Bug Tracker, https://github.com/jaywhj/mkdocs-materialx/issues
Project-URL: Repository, https://github.com/jaywhj/mkdocs-materialx
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.30
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

## MaterialX for MkDocs

<br />

**MaterialX**, the next generation of mkdocs-material, is based on `mkdocs-material-9.7.0` and is named `X`. It continues to be maintained by individual developers (since mkdocs-material will cease maintenance) to keep the MkDocs ecosystem alive!

<br />
<br />

<p align="center">
  <img src="docs/assets/screenshots/m-sample1.png" width="700" />
  <img src="docs/assets/screenshots/m-sample4.png" width="700" />
</p>



## Quick start

Installation:

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

Add the following lines to `mkdocs.yml`:

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

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

<br />

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

<br />

## Chat Group

**Discord**: https://discord.gg/cvTfge4AUy

**Wechat**: 

<img src="docs/assets/images/wechat-group.jpg" width="140" />