gitbook

我主要通过 gitbook 将 markdown 编写的技术文档构建成电子书，用于日常检索。

# 构建
gitbook build
# 开启服务
gitbook serve
# 我使用的版本
gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

插件

gitbook 自带有一些插件，社区也提供一些插件需要额外安装，插件配置文件是 book.json

• 自带插件
  • livereload
  • highlight
  • search
  • lunr
  • sharing
  • fontsettings
  • theme-default
• 三方插件
  • page-toc

toc

# 安装插件
npm i gitbook-plugin-page-toc

插件配置

{
  "plugins": ["page-toc"],
  "pluginsConfig": {
    "page-toc": {
      "selector": ".markdown-section h1, .markdown-section h2, .markdown-section h3, .markdown-section h4",
      "position": "before-first",
      "showByDefault": true
    }
  }
}