gitbook目录折叠

背景

在编写gitbook的时候发现目录的数量比较庞大的时候显得杂乱无章,因为章节比较多的时候gitbook对于目录默认是全展开,很难有目的地寻找,对于管理人和阅读的读者来说很不友好。(主要是后者,一切都要从用户的角度考虑)

如果可以将gitbook的目录折叠,那么查找时会更加清晰,笔者在网上找到了插件,只要让gitbook引入即可。

插件

  • 插件名称:toggle-chapters
  • 效果:默认只在目录导航中显示章的标题,而不会显示小节的标题,点击每一章或者每一节会显示当前章或节的子目录,如果有的话,但是同时会收起其它之前展开的章节。

关于更多的gitbook插件,读者可以参考插件网站

配置

在根目录(即与SUMMARY.md同级的目录)下的配置文件 book.json(如果没有则新建)中添加插件配置,如图:

样图
读者可以参考进行配置,同理你可以在里面添加需要使用的插件。

配置完成后,可按照一下步骤进行:

  • $ cd gitbook根目录
  • $ npm install gitbook-plugin-toggle-chapters (此时gitbook的根目录下的node_modules文件夹中已经有了该插件了)
  • $ gitbook build
  • $ gitbook serve
    访问 http://localhost:4000 看你的插件是否已经生效。
显示 Gitment 评论