#mdbook #summary #generate

app mdbook-generate-summary

自动生成 mdBook SUMMARY.md 文件的工具

2 个不稳定版本

0.2.0 2019 年 6 月 14 日
0.1.0 2019 年 3 月 27 日

#29#summary

33 每月下载量

MIT 许可证

14KB
266

mdbook-generate-summary

这是一个用于为 mdBook 仓库 生成 SUMMARY.md 页面的 CLI 工具。

我编写了这个工具,因为我正在将 mdBook 作为知识库而不是实际的书籍来使用。我想尽可能简化添加页面的过程,并减少对维护 SUMMARY.md 的担忧。

然而,这对你书籍的布局做了一些假设

每个子页面都有一个相应的 README.md 文件。

例如,你的书籍将在 src/ 下始终具有以下目录结构

foo.md
bar/README.md
bar/something_else.md
baz/README.md

也就是说,你永远不会有一个包含 .md 文件但不也包含 README.md 文件的目录。

如果你有,程序将不会检测到这种边缘情况,并且不会执行正确操作。

依赖关系

~3.5MB
~69K SLoC