插件

gitbook支持插件,在下面的地址有众多的插件可供选择:

https://plugins.gitbook.com/

比较感兴趣的插件

  • Github Plugin: 在gitbook上显示一个连接到github仓库的图标和链接
  • Ace Plugin: 支持ACE代码编辑器
  • Tbfed-pagefooter: 为页面添加页脚,可以增加版权信息和文件的最后修订时间
  • Sectionx: 将页面分块显示
  • Codeblock-filename: 为代码块添加文件名称,当需要明确指出代码来自那个文件或者类时可以考虑使用

  • Include Codeblock: 使用代码块的格式显示所包含文件的内容.

  • etoc: toc的改进版本

重点使用的插件

  • Toggle Chapters: 左侧的章节目录可以折叠!
  • Edit Link: 使用该插件可以链接到当前页在github的源文件上,可以直接在线编辑。配合gitbook的自动构建,修改少量内容时可以非常的方便快捷。
  • back-to-top-button: 添加一个可以回到顶端的按钮,配合 toc,对于比较长的页面很好用
  • Splitter: 可以自由调节侧边栏的宽度
  • Tags: 在页面内容中添加一行指定当前页面的tag,然后会自动汇总所有tag和页面信息到一个tags页面,方便查找相关内容。
  • callouts:比较好看的提示标注
  • theme-comscore: 为标题增加色彩,默认都是黑色
  • wide-page: 流动的页面宽度,而不是默认的固定宽度

准备研究的插件