为 mdBook 项目自动生成 SUMMARY.md 文件的工具。

解决什么问题

用 mdBook 写技术书时,每次添加新章节都要手动修改 SUMMARY.md

章节多了之后,维护目录结构变得繁琐且容易出错。

核心方案

这个工具自动扫描目录结构,生成 SUMMARY.md

  • 自动扫描 - 递归扫描指定目录
  • 智能过滤 - 支持 .mdbookignore 文件
  • 一键生成 - gms -d src -o src/SUMMARY.md

与手动维护相比:

  • 节省时间,不用反复修改
  • 减少错误,自动处理层级
  • 重构友好,目录变了重新生成即可

快速体验

cargo install gen-mdbook-summary
gms -d src -o src/SUMMARY.md

项目链接


欢迎 Star、Issue 和 PR! ⭐