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)
For a more detailed description of the differences, see documentation: Why MaterialX
| Aspect | mkdocs-material | MaterialX |
|---|---|---|
| Latest Version | mkdocs-material-9.7.1 | mkdocs-materialx-10.x (based on v9.7.1) |
| Current Status | Nearing end-of-maintenance | Active maintenance and updates |
| Feature Updates | None (with legacy bugs) | Bug fixes, new feature additions, UX improvements, etc. See Changelog |
| Aspect | Zensical | MaterialX |
|---|---|---|
| Audience | Technical developers Technical documentation |
All users Markdown notes & documents |
| Direction | Increasingly feature-heavy and complex | Prioritizes extreme ease of use, stays increasingly lightweight |
| Language | Rust | Python |
| Stage | Early-stage | Mature and stable |
| Ecosystem | Non-existent, uncertain future | Rich, open, and vibrant |
Installation:
pip install mkdocs-materialxAdd the following lines to mkdocs.yml:
theme:
name: materialxNote
The theme name is materialx, not material. Everything else is the same as when using material.
For detailed installation instructions, configuration options, and a demo, visit jaywhj.github.io/mkdocs-materialx
Discord: https://discord.gg/cvTfge4AUy
Wechat:
