Metadata-Version: 2.4
Name: mkdocs-materialx
Version: 10.0.7
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.1` and is named `X`. It continues to be maintained by individual developers (since mkdocs-material will cease maintenance)

<p align="center">
  <img src="docs/assets/screenshots/recently-updated-en.gif"/>
</p>

## What Difference

For a more detailed description of the differences, see documentation: [Why MaterialX](https://jaywhj.github.io/mkdocs-materialx/differences/)

<br />

### Differences from Material

| Aspect              |          mkdocs-material           |                       MaterialX                   |
| ------------------- |  --------------------------------  |  -----------------------------------------------  |
| **Latest Version**  |       mkdocs-material-9.7.1        | mkdocs-materialx-10.x <br />(based on mkdocs-material-9.7.1) |
| **Usage**           | Use mkdocs.yml with the theme name `material` | Use mkdocs.yml with the new theme name `materialx`, everything else is the same as when using material |
| **Current Status**  |     Nearing end-of-maintenance     |          Active maintenance and updates           |
| **Feature Updates** |      None (with legacy bugs)       | Bug fixes, new feature additions, UX improvements,<br />see [Changelog](https://github.com/jaywhj/mkdocs-materialx/releases) |

### Differences from Zensical

| Aspect         |                    Zensical                  |                        MaterialX                  |
| -------------- | -------------------------------------------- | ------------------------------------------------- |
| **Audience**   | Technical developers <br /> Technical documentation | All markdown users <br /> Markdown notes & documents |
| **Language**   |                      Rust                   |                  Python               |
| **Stage**      | Launched a few months ago, in early stages, basic functionality incomplete | Launched for over a decade, mature and stable |
| **Usage**      | Adopt the new TOML configuration format, all configurations in the original mkdocs.yml need to be reconfigured from scratch | Continue to use mkdocs.yml with zero migration cost |
| **Ecosystem**  | Built entirely from scratch, incompatible with all original MkDocs components, future development uncertain | Based on MkDocs & mkdocs-material-9.7.1, fully compatible with MkDocs' rich long-built ecosystem, open and vibrant |
| **Core Focus** | Prioritizes technical customization, with increasingly cumbersome feature configurations and ever-growing complexity in usage | Focuses on universal functions & visual presentation, extreme ease of use as primary principle, evolving to be more lightweight |

<br />

## Quick Start

Installation:

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

Configure `materialx` theme 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" />