mkdocs-materialx 10.2.1

MaterialX

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.

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 provides ongoing maintenance and updates.

Update Highlights

• Added Markdown source support for AI agents to provide structured content, reducing token consumption by over 80%
• Refactored the search module with a brand-new architecture, supporting Pagefind framework, and greatly improving search quality and indexing efficiency. It supports multi-provider mode, chunked indexing, on-demand loading, index compression, multilingual search and cross-domain search. It is suitable for various complex scenarios and large-scale sites, and can handle sites with more than 100,000 pages, see Search
• Added code block download & auto-collapse/expand long code blocks features, see Code blocks
• Added the new Steps component for clearer, more intuitive display of procedures and workflows, see Steps
• Enhanced blog and support for CJK languages
• Added next-generation date & author plugin, see: Add document dates & authors
  • It's 20-500 times faster than git-revision-date-localized and git-authors, and works in any environment (no-Git, Git environments, Docker, all CI/CD build systems, etc.).
  • Completely resolved date and time infrastructure issues, enabling the project to support automated date processing. Manual date configuration is no longer required for any feature, including: page date display, blog post dates, blog date archives, blog list sorting, sitemap.xml (lastmod - SEO improvements), RSS feeds, recently updated section, search ranking, and more
• Added Recent Updated module, see: Add recent updates module
  • Automatically generates document summaries (no manual configuration needed)
  • Intelligently estimates reading time, supporting all languages (CJK languages + Space-delimited languages)
• Refactored the mobile TOC component for seamless NAV and TOC experience on mobile (better interactive experience)
• Perfectly fixed the issue where swipe gestures would penetrate when the sidebar drawer was active on mobile (prone to accidental operations and poor user experience; unresolved in Zensical and Material)
• Significantly polished the UX and details on mobile devices
  • Moved the "Back to top" container to the bottom, aligning with natural interaction logic
  • Optimized the show/hide sensitivity of the "Back to top" container
  • Added indent guide lines and active link accent colors for the TOC
• Added the modern Liquid Glass theme, allows setting the topbar background color in the Liquid Glass theme to support backgrounds with different color schemes, see Topbar style
• For more details, see Changelog

Quick Start

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

Chat Group

Discord: https://discord.gg/cvTfge4AUy