首页
/ MkDocs Material 9.5.14版本新增对Mike隐藏版本的支持

MkDocs Material 9.5.14版本新增对Mike隐藏版本的支持

2025-05-09 09:51:45作者:滕妙奇

MkDocs Material作为一款广受欢迎的文档站点生成器,在9.5.14版本中新增了对Mike版本管理插件中隐藏版本的支持。这一功能改进使得开发者能够更灵活地控制文档版本的选择器显示逻辑。

在文档版本管理场景中,开发团队通常会维护多个版本的文档:

  • 正式发布的稳定版本(如1.0.0、0.20.1等)
  • 开发中的版本(如dev-0.20.x、dev-main等)

通过Mike插件生成的version.json文件中,每个版本都可以配置properties属性。当某个版本被标记为hidden: true时,MkDocs Material的版本选择器将自动过滤掉这些版本,不会在前端显示。

这一改进的技术实现要点包括:

  1. 版本选择器渲染逻辑增加了对hidden属性的检测
  2. 隐藏版本仍然保留在版本系统中,只是不显示在UI层面
  3. 不影响原有的版本跳转和别名功能

使用这一功能后,文档站点可以:

  • 保持版本选择器的简洁性
  • 避免用户误选开发中的不稳定版本
  • 同时保留完整的版本历史记录

对于使用MkDocs Material和Mike插件的团队来说,这是一个小而实用的改进,特别适合需要同时维护多个文档分支的大型项目。通过简单的配置就能实现更专业的文档版本管理体验。

登录后查看全文
热门项目推荐
相关项目推荐