The next generation of mkdocs-material, build beautiful sites the way you already know and love.
3.2K
MaterialX, the next generation of mkdocs-material, build beautiful sites the way you already know and love, based on mkdocs-material-9.7.1 and named X, it provides ongoing maintenance and updates.
The MkDocs project is nearing its end due to personal issues involving its original author. He has ceased updates for MkDocs and intends to release a completely new 2.0 version as a replacement. However, this new version is entirely incompatible with the existing ecosystem. It is an entirely separate project that merely carries the MkDocs name, and an accidental upgrade will result in devastating damage.
As a result, to break free from dependency on MkDocs, the team behind the popular mkdocs-material theme framework has discontinued its maintenance and shifted to developing an entirely new alternative project named Zensical. While it adopts a new architecture and eliminates dependency on MkDocs, it still lacks many features. In addition, it is incompatible with the existing MkDocs ecosystem, making many existing plugins unavailable. This imposes certain migration costs on users, and its stability remains unproven.
To ensure the continued stable operation of existing MkDocs projects and ecosystem, a new community-driven successor to MkDocs has emerged: ProperDocs (based on MkDocs 1.6.1). It will provide ongoing updates and maintenance while remaining fully compatible with the original MkDocs ecosystem.
Similarly, mkdocs-material also has a new successor: MaterialX (based on mkdocs-material 9.7.1). It provides ongoing maintenance and updates, with full compatibility with the original ecosystem and zero migration costs.
In short: MaterialX + ProperDocs is an equivalent replacement for mkdocs-material + mkdocs and provides ongoing maintenance and updates.
MaterialX preserves the rich features and stability of the mkdocs-material project, while delivering new features and broad compatibility, and will adopt the following brand-new vision and positioning.
git-revision-date-localized and git-authors, and works in any environment (no-Git, Git environments, Docker, all CI/CD build systems, etc.).1 - Installation:
pip install mkdocs-materialx
2 - Configure materialx theme to mkdocs.yml:
theme:
name: materialx
3 - Start a live preview server with the following command for automatic open and reload:
for MkDocs :
mkdocs serve --livereload -o
for ProperDocs :
properdocs serve -o
For detailed installation instructions, configuration options, and a demo, visit jaywhj.github.io/mkdocs-materialx
Content type
Image
Digest
sha256:aa86d0bc6…
Size
117 MB
Last updated
3 months ago
docker pull jaywhj/mkdocs-materialx