Releases: jaywhj/mkdocs-materialx
Releases · jaywhj/mkdocs-materialx
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
mkdocs-materialx-10.1.1
en
- Added support for ProperDocs
- Date & time infrastructure (provided by the built-in plugin
document-dates; remember to enable it in thepluginssection)- 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 an override template for
sitemap.xmlthat supports dynamically loading the exact lastmod to improve SEO, see sitemap.xml
- Updated the processing logic for blog post dates, manual date specification is no longer required
- These date values can be accessed via template variables in any template or plugin, see Template Variables
- Recently updated list
- Added high-performance readtime & summary parsers
- Added
readtimeandtagrendering, for readtime calculation details see Reading-Time-Estimation - Added line count configuration for
summary, see Summary-Line-Configuration - Improved layout styling for mixed text and image content
- Tags
- Fixed a bug in tag list parsing
- Improved compatibility for sorting of the tags index list
- Corrected the incorrect example for listings tags sorting
- Moved tags display position from top to bottom
- Enable icon for tags by default to lower usage barriers
- Updated template variables and removed the
_mxnode - Fixed styling issues for admonition & button
zh
- 新增了对 ProperDocs 的支持
- 日期与时间基建（由内置插件
document-dates提供，记得在plugins中启用它）- 彻底解决了日期与时间相关的基础架构问题，让项目有了自动化日期的能力，再也无需为任何功能手动设置日期，包括：页面日期展示、blog 日期展示、blog 日期分类、blog 列表排序、sitemap.xml (lastmod - SEO 增强)、RSS feed、最近更新模块、搜索排序等
- 新增了
sitemap.xml覆盖模板，支持动态加载精确的 lastmod 以提升 SEO 效果，详见 sitemap.xml - 更新了 blog 文章日期的处理逻辑，不再需要手动指定日期
- 可在任意模板或插件中通过模板变量访问这些日期数据，详见 模板变量
- 最近更新列表
- 标签
- 修复了标签列表解析的一个bug
- 提升了标签索引页排序的兼容性
- 修正了列表标签排序的错误示例
- 将标签展示位置从顶部调整至底部
- 默认启用标签图标，降低使用门槛
- 更新了模板变量，移除
_mx节点 - 修复了提示框（admonition）与按钮的样式问题
mkdocs-materialx-10.1.0
en
- Fixed the version number matching bug for info plugin
- Fixed that back-to-top was not centered on the blog page
- Fixed blog page not showing return title in left sidebar on desktop
- Optimized user experience:
- Adjusted the scope of scroll penetration prevention for the scrollfix container to mobile devices only
- Adjusted the top value of the admonition icon so that it is always aligned with the top line
- Adjusted the color depth of the indentation guide
- When the TOC is empty, do not hide the "Show TOC" button, instead, display a text prompt in the TOC sidebar
- Adjusted the dependency configuration method: removed
requirements.txtand migrated all dependency configurations topyproject.toml - Optimized the build order in the Dockerfile to improve the utilization rate of Docker build cache, thereby enhancing build efficiency
- Updated the template examples for date plugin
zh
- 修复了 info 插件的版本号匹配 bug
- 修复了 back-to-top 在 blog 页面不居中的问题
- 修复了 blog 页面在桌面端左侧边栏不显示返回标题的问题
- 优化了用户体验：
- 将防止 scrollfix 容器滚动渗透的范围调整为仅限移动设备
- 调整了 admonition 图标的 top 值，使其始终对齐 top line
- 调整了缩进参考线的颜色深度
- 当 TOC 为空时，不隐藏 "Show TOC" 按钮，而是在 TOC 侧边栏显示文字提示
- 调整了依赖关系配置方法：去除了
requirements.txt，全部改为使用pyproject.toml - 优化了 Dockerfile 中的构建顺序，提高了 Docker build cache 的利用率，从而提升构建效率
- 更新了日期插件的模板示例
mkdocs-materialx-10.0.9
en
- Added configurable styles for topbar, allow to set topbar background color in liquid glass theme, see Topbar style
- Make color-mix of navigation background compatible with iOS 14 and earlier
- Optimized the css details of NAV and TOC on different platforms again to improve the aesthetics
zh
- 为 topbar 增加了可配置样式，允许在液态玻璃主题中设置 topbar 背景颜色，详情见 Topbar style
- 让导航背景的颜色搭配与 iOS 14 及更早版本兼容
- 再次优化了不同平台上 NAV 和 TOC 的 css 细节，提升了美观度
mkdocs-materialx-10.0.8
en
- Highlights: Fixed issue where swipe events would wear through on mobile
- Highlights: Adjust the “back to top” container to dynamic positioning, now it will be intelligently centered and auto-hide when not needed
- Adjust the color of active link from
accenttoprimary, the primary color is used for active links in NAV and TOC, text links and several other components - Optimize nav & toc styles
- Adjusted the style of
admonition - Added underline for text link on hover/focus
- Fixed incorrect actor-line color in
mermaidsequence - Fixed issue where the top container may be blocked by the tabbed
- Fixed search containers vertical not centered issue
- Fixed
annotationbutton vertical not centered issue
zh
- 重点更新 ：修复了在移动设备上轻扫事件会穿透的问题
- 重点更新 ：将 "返回顶部 "容器调整为动态定位，现在它会智能居中，并在不需要时自动隐藏
- 将活动链接的颜色从
accent调整为primary，primary 用于导航和目录中的活动链接、文本链接和其他一些组件 - 优化了 nav 和 toc 样式
- 调整了
admonition的样式 - 在悬停/聚焦时为文本链接添加了下划线
- 修复了
mermaidsequence 图中 actor-line 颜色不正确的问题 - 修复了顶部容器可能被选项卡遮挡的问题
- 修复了搜索容器垂直不居中的问题
- 修复了
annotation按钮垂直不居中的问题
mkdocs-materialx-10.0.7
en
- Highlights: Fixed issue where swipe events would wear through on mobile
- Highlights: Adjust the “back to top” container to dynamic positioning, now it will be intelligently centered and auto-hide when not needed
- Adjust the color of active link from
accenttoprimary, the primary color is used for active links in NAV and TOC, text links and several other components - Adjusted the style of
admonition - Added underline for text link on hover/focus
- Fixed incorrect actor-line color in
mermaidsequence - Fixed issue where the top container may be blocked by the tabbed
- Fixed search containers vertical not centered issue
- Fixed
annotationbutton vertical not centered issue
zh
- 重点更新 ：修复了在移动设备上轻扫事件会穿透的问题
- 重点更新 ：将 "返回顶部 "容器调整为动态定位，现在它会智能居中，并在不需要时自动隐藏
- 将活动链接的颜色从
accent调整为primary，primary 用于导航和目录中的活动链接、文本链接和其他一些组件 - 调整了
admonition的样式 - 在悬停/聚焦时为文本链接添加了下划线
- 修复了
mermaidsequence 图中 actor-line 颜色不正确的问题 - 修复了顶部容器可能被选项卡遮挡的问题
- 修复了搜索容器垂直不居中的问题
- 修复了
annotation按钮垂直不居中的问题
mkdocs-materialx-10.0.6
en
- New: The recently updated document list supports summary mode and automatically extracts article summaries, preview
- New: The recently updated document list supports dynamic layout, with multiple view modes added including list, detail and grid
- Updated: Adjusted the UI style of
admonition - Updated: Adjusted the UI style of
blockquote - Updated: Adjusted the UI style of the search box
- Updated: Adjusted the tooltip layer level to prevent it from obscuring tabs
- Updated: Adjusted the vertical spacing of the page-turning buttons in the footer
- Fixed: The issue where the back-to-top button was not centered
zh
- 新增：最近更新的文档列表支持摘要模式，会自动提取文章摘要，预览
- 新增：最近更新的文档列表支持动态布局，新增列表、详情、网格等多种视图模式
- 更新：调整 admonition 的 UI 样式
- 更新：调整 blockquote 的 UI 样式
- 更新：调整搜索框的 UI 样式
- 更新：调整 tooltip 层级以避免挡住 tabs
- 更新：调整页脚翻页按钮上下间距
- 修复：back-to-top 按钮不居中的问题
mkdocs-materialx-10.0.5
en
- New: Refactor the TOC components for mobile, now you can experience TOC perfectly on mobile!
- New: Add a new generation date author plugin, see doc Add document dates authors
- New: Add recent updates module, see doc Add recent updates module
- Fixed: Show/hide bottom navigation container wisely
- Fixed: TOC not hiding when clicked
- Fixed: Gaussian Blur not working in Safari
- Fixed: Adjust animation delay
- Fixed: Adjust TOC line spacing
zh
mkdocs-materialx-10.0.4
en
- New: Refactor the TOC components for mobile, now you can experience TOC perfectly on mobile!
- New: Show
git repoin sidebar on mobile - New: Add a new generation date author plugin, see doc Add document dates authors
- New: Add recent updates module, see doc Add recent updates module
- Fixed: Placing the back-to-top button at the bottom, this is more in line with the interaction logic of proximity operation
- Fixed: Optimize the judgment of the direction of the swipe gesture, so as to adjust the sensitivity of showing the bottom menu
- Fixed: Search function does not display properly on mobile
- Fixed: iconsearch_index.json write issue
- Fixed: Language selector escapes viewport when too wide on mobile
- Fixed: Replace the gap attribute to increase compatibility
- Fixed: Adjust the style for kbd styles
- Fixed: Adjust the border-radius of all styles
- Fixed: Adjust UI shadow effect
- Fixed: Merge the upstream 9.7.1 update
- Fixed: Update Doc Site, see MaterialX
zh
- 新增: 针对移动设备重构 TOC 组件，现在您可以在移动设备上完美体验 TOC！
- 新增: 在移动设备侧边栏添加
git repo显示 - 新增: 添加新一代日期作者插件，参见文档 添加文档日期作者
- 新增: 添加最近更新模块, 参见文档 添加最近更新模块
- 修复: 将「回到页面顶部」按钮放在底部，更符合近距离操作的交互逻辑
- 修复: 优化对轻扫手势方向的判断，以调整显示底部菜单的灵敏度
- 修复: 搜索功能在手机上无法正常显示的问题
- 修复: iconsearch_index.json 的写入问题
- 修复: 语言选择器在移动设备上太宽时会跳出视口
- 修复: 替换 gap 属性以增加兼容性
- 修复: 调整 kbd styles 的样式
- 修复: 调整所有样式的边框半径
- 修复: 调整 UI 阴影效果
- 修复: 合并上游 9.7.1 更新
- 修复: 更新文档站点, 参见 MaterialX