用于自动生成 SUMMARY.md 的 Gitbook 插件
gitbook-plugin-summary
这个插件是出于没有办法从基本的树结构中自动生成 SUMMARY.md 文件的挫败感而创建的。结果是您安装了此插件,它就可以在当前文件之上工作。无需自定义配置。book.json
安装
首先,您需要使用
$ npm i gitbook-plugin-summary --save
之后,您需要添加到您的插件中,如下所示book.json
{"plugins": ["summary"] }
,最后运行命令
$ gitbook serve
规则
名字
-
README.md:取自他们的目录名称
-
文件:取自文件的第一个第一个标头(例如:)
# title
-
目录: 目录的名称
条目类型
目录在 gitbook 的根目录
-
如果其中有自述文件第一级,它将显示为普通链接
-
如果没有,它将显示为一个部分
嵌套目录
-
如果其中有自述文件第一级,它将显示为普通链接
-
如果没有,它将显示为标签(或禁用的链接,如果你愿意的话)
文件
-
仅显示降价文件
例
让我们假设您的源代码树是按如下方式完成的:
$ tree . . ├── 1-Getting Started │ ├── 0-README.md │ └── 1-TEST.md ├── 2-Reference │ └── 0-README.md ├── README.md └── SUMMARY.md
您的SUMMARY.md文件将如下所示:
- [Getting Started](1-Getting Started/0-README.md)- [Test](1-Getting Started/1-TEST.md) - [Reference](2-Reference/0-README.md)
这就是它将在你的Gitbook中显示的方式:
故障 排除
-
无法识别代码跨度(带有后面的刻度)。因此,最好避免,直到有人发现它足够重要,可以解决该:P
-
如果看起来没有重新呈现,请再次保存。在第二次服务器重新启动时会考虑更改。
-
unexpected token function
:这是由代码中唯一的异步等待引起的。2修复方法。首先,安装节点 7.6+。其次,拉取请求它。这只是2-3行的变化:)
许可证
查看许可证
关键字
-
gitbook
-
gitbook-plugin
-
gitbook-summary