Repository navigation
Releases
Releases · jaywhj/mkdocs-materialx
MaterialX-10.2.2
en
- Enhanced
blogfunctionality:- Major performance boost via new architecture: 4x higher build efficiency and significantly reduced build time
- Improved reading time estimation: supports all major & mixed languages (new CJK support), and covers all Markdown content blocks, see post_readtime
- Added sharing module with one-click social sharing (Mastodon/Bluesky/SinaWeibo/QQ/Douban), see share_links
- Fixed page rendering efficiency issues caused by the CSS
:has()selector - Fixed incorrect sitemap handling of non-language alternate links
- Fixed date formatting when no locale is available
- Fixed inline code rendering in Lunr search result titles
zh
- 增强了
blog功能:- 采用全新架构实现大幅性能优化:构建效率提升 4 倍,构建时长显著缩短
- 优化了阅读时长预估:支持所有主流语言与混合语言(新增 CJK 支持),覆盖各类 Markdown 内容块,详见 post_readtime
- 新增分享模块,支持一键分享至社交平台(Mastodon/Bluesky/ 新浪微博 / QQ / 豆瓣),详见 share_links
- 修复了由 CSS
:has()选择器引发的页面渲染效率问题 - 修复了站点地图对非语言类备选链接的处理错误
- 修复了无可用区域配置时的日期格式化异常
- 修复了 Lunr 搜索结果标题中行内代码的渲染问题
mkdocs-materialx-10.2.1
en
- Refactored the search functionality with a brand-new architecture, supporting the Pagefind framework, and greatly improving search quality and indexing efficiency. It supports chunked indexing, on-demand loading, index compression, ... see Search
- Added
Co-Authored-Bysupport for Git authors - Added aggregation support for Git
Co-Authored-Byentries. You can consolidateCo-Authored-Byauthors in the.mailmapfile. See Git author aggregation - Enhanced author configuration —
authors.ymlnow supports author exclusion. See Enhanced author configuration - Fixed styling issues with the Steps component
- Fixed bugs related to the code folding feature
- Fixed escaping issues in summaries of the recent update module
zh
- 以全新架构重构了搜索功能,支持 Pagefind 框架,大幅提高搜索质量和索引效率。支持分块索引、按需加载、索引压缩、多语言搜索、跨域搜索等,见 Search
- 为 Git authors 添加
Co-Authored-By支持 - 为 Git
Co-Authored-By添加聚合支持,可在.mailmap中聚合Co-Authored-By协作者,见 Git author aggregation - 增强作者配置 -
authors.yml支持作者排除,见 Enhanced author configuration - 修复了 Steps 组件的样式问题
- 修复了代码折叠功能的相关 bug
- 修复了最近更新模块摘要的转义问题
mkdocs-materialx-10.2.0
en
Milestone Update:
- Refactored the search functionality with a brand-new architecture design, drastically improving search quality and indexing efficiency. It supports 100,000+ pages, chunked indexing, on-demand loading, index compression, multi-language capability, multiple search providers, and more, see Search
- Added the new Steps component for clearer, more intuitive display of procedures and workflows, see Steps
- Brand-new MaterialX logo, courtesy of contributions from @johnpiers Logo Set
zh
重磅更新:
- 以全新架构重构了搜索功能,大幅提高搜索质量和索引效率。支持 100,000+ 页面,支持分块索引、按需加载、索引压缩、多语言搜索、跨域搜索等,具体见 Search
- 新增 Steps 组件,可更清晰、直观地显示步骤或工作流,具体见 Steps
- 全新的 MaterialX logo,感谢 @johnpiers 的贡献 Logo Set
mkdocs-materialx-10.1.8
en
- Enhanced reading time calculation for blog posts, see post_readtime
- Supports calculation for various Markdown blocks, including tables, fenced blocks, math blocks, images and more
- Supports all mainstream languages and mixed-language, including Space-delimited languages & CJK languages
- Improved parsing performance for faster computation
- Exposed API for reading time calculation, facilitating invocation and integration by other plugins and hooks, see analyze_markdown
- Optimized styles for collapsible code blocks with compatibility for the
resultclass style
zh
- 增强了 blog 计算阅读时长功能,参见 post_readtime
- 支持各种 Markdown 内容块的计算,如表格、栅栏块、数学块、图像等
- 支持所有主流语言,支持混合语言,包括空格分隔型语言和 CJK 语言
- 提升了解析性能,加快了计算速度
- 对外开放了计算阅读时长的 API,方便其它插件和钩子调用和集成,参见 analyze_markdown
- 优化了折叠代码块的样式,兼容
result类样式
mkdocs-materialx-10.1.7
en
- Fixed the historical legacy bug where code highlighting failed to fully cover long lines
- Fixed the historical legacy bug where annotation would not remount when a tabbed block is toggled from hidden to visible
- Fixed the historical legacy issue where arrows in Mermaid sequence diagrams lacked visibility under dark themes
- Refactored the implementation for collapsing long code blocks to improve robustness, and added compatibility with iOS 14
- Changed the default collapse threshold for long code blocks from 12 to 15
- Updated annotation default icon to info
zh
- 修复了代码高亮对长代码行覆盖不全的问题(历史遗留 bug)
- 修复了 Tabbed block 从隐藏切换为可见时 annotation 不会被重新挂载的 bug
- 修复了 Mermaid 序列图中的箭头在深色主题下不突出的问题(历史遗留 bug)
- 优化了折叠长代码块的实现,增强了鲁棒性,适配了 iOS 14
- 将长代码块的默认折叠阈值从 12 调整为 15
- 更新了 annotation 默认图标为 info
mkdocs-materialx-10.1.6
en
- Added automatic collapse for long code blocks, see: code-collapse-expand
- Supports global configuration for the line‑count threshold to trigger collapse
- Allows individual long code blocks to have custom collapse thresholds or disable collapsing entirely
- Added
co-authorsupport for git authors - Updated date formatting tool to babel
- Optimized color schemes
zh
- 新增自动折叠长代码块功能,具体见:code-collapse-expand
- 支持统一配置折叠触发阈值行数
- 支持为某个长代码块单独设置折叠触发阈值或禁用折叠
- 为 git authors 添加了
co-author支持 - 更新日期格式化工具为 babel
- 优化了配色方案
mkdocs-materialx-10.1.5
en
- Added Markdown page support for AI agents, see Markdown for AI agents
- Added download functionality for fenced code blocks, see Code download button
- Added Lucide icons, see Search
- Updated dependency versions
zh
- 新增 AI agents 的 Markdown 页面支持, 详情见 Markdown for AI agents
- 新增围栏代码块的下载功能, 详情见 Code download button
- 新增 Lucide 图标库, 见 Search
- 更新依赖包版本
mkdocs-materialx-10.1.4
en
- Added official Docker image, see installation with docker
- Updated documentation workflow
- Restored build workflow
- Optimized the date loading mechanism of the blog plugin
- Manual date configuration for each post is no longer required, and the date plugin no longer needs to be enabled
- Fixed inconsistent icon rendering sizes across different icon families when customizing Admonitions
- Fixed the issue where annotation tooltips inside admonitions were clipped
- Fixed issues arising from incorrect mounting logic for Code Annotations
- Significantly updated project documentation, including plugins, setup, admonitions and more
zh
- 添加了官方 Docker 镜像,见 installation with docker
- 更新了文档工作流
- 恢复了构建工作流
- 优化了 blog 插件的日期加载机制
- 不再需要给每一篇博客手动配置日期,也不需要启用日期插件
- 修复了自定义 Admonition 时不同图标族的图标渲染尺寸不一致的问题
- 修复了在 Admonition 中的 Annotation Tooltip 被裁剪的问题
- 修复了 Code Annotations 的挂载机制不对引起的问题
- 大幅度更新了项目文档:plugins、setup、admonitions ...
mkdocs-materialx-10.1.3
en
- Feature: Bundled icons can now be used as favicon, see Favicon
- Feature: Modularized Admonition for easier extensibility( #28 #14 )
- Customizing a new admonition can now be done simply by configuring it in
mkdocs.yml, see Customization
- Customizing a new admonition can now be done simply by configuring it in
- Fixed compatibility issue with the
lastmodvalue insitemap.xml- When used with the
document-datesplugin,sitemap.xmlcan now generate the exactlastmod, see sitemap.xml
- When used with the
- Optimized inline code block style
- Fixed #23 #34
zh
- 新功能:内置 icons 现支持用作网站 favicon,详见 Favicon
- 新功能:提示框(Admonition)模块化改造,扩展性大幅提升 ( #28 #14 )
- 现在定制一个新的 admonition 只需在 mkdocs.yml 中配置即可,详见 Customization
- 修复了 sitemap.xml 中
lastmod值的兼容性问题- 结合插件 document-dates, sitemap.xml 可生成准确的 lastmod,详见 sitemap.xml
- 优化了行内代码块样式
- 修复问题 #23 #34
mkdocs-materialx-10.1.2
en
- Fixed the robustness of the
document-datesplugin when running with the blog plugin #19 - Fixed the border gap issue for
admonitions&details#17 - Updated the usage documentation for the
document-datesplugin, see Configuration - Updated project development setup #18
- Archived unnecessary docs and exclude them from the build, see Archives
zh
- 修复了
document-dates插件与blog插件一起运行时的稳定性 #19 - 修复了
admonitions与details的边框间隙问题 #17 - 更新了
document-dates插件的使用说明,见 Configuration - 更新了项目开发设置 #18
- 归档不需要的文档,并将其排除在构建之外,见 Archives