插件配置

• Plugins插件可用于：

  • 支持数学公式的展示
  • 使用Google分析来跟踪访问请求
  • ...

• 安装与引用

  • 执行$ npm install plugin_name -g并更新book.json；
  • 或先更新book.json，然后直接执行$ gitbook install自动安装所有插件；

• book.json

  • plugins 需要加载的插件数组

      {
          "plugins": ["myPlugin", "anotherPlugin"]
      }
    

  • pluginsConfig 对插件的配置

• 默认插件

  • GitBook推荐插件的命名方式
    • gitbook-plugin-X: 插件
    • gitbook-theme-X: 主题
  • GitBook默认带有6个插件：
    • font-settings
    • highlight
    • lunr
    • search
    • sharing
    • theme-default

  • 去除自带插件， 可在插件名前加-

          "plugins": [
              "-search"
          ]
    

• 常用插件

  • 主题插件comscore

  • disqus集成用户评论系统

    • 1.首先注册disqus
    • 2.然后添加website，获得关键字

    • 3.集成时配置关键字

      • 安装disqus $ npm install gitbook-plugin-disqus -g

      • 更新bookjson

              {
                  "plugins": ["disqus"],
                  "pluginsConfig": {
                      "disqus": {
                          "shortName": "创建的 website 获得的唯一关键字"
                      }
                  }
              }
        

  • Duoshuo多说

          "plugins": [
              "duoshuo"
          ],
          "pluginsConfig": {
              "duoshuo": {
                  "short_name": "your duoshuo's shortname",
                  "theme": "default"
              }
          }
    

  • plugin-github添加github图标

      "plugins": [
          "github"
          ],
      "pluginsConfig": {
          "github": {
              "url": "https://github.com/zhilidali/"
          }
      }
    

  • Sharing分享当前页，gitbook的默认插件, 禁用：plugins: ["-sharing"]

          "pluginsConfig": {
              "sharing": {
                  "weibo": true,
                  "facebook": true,
                  "twitter": true,
                  "google": false,
                  "instapaper": false,
                  "vk": false,
                  "all": [
                      "facebook", "google", "twitter",
                      "weibo", "instapaper"
                  ]
              }
          }
    

  • Splitter

    • 使侧边栏的宽度可以自由调节:"plugins": [ "splitter" ]

  • Tbfed-pagefooter为页面添加页脚

          "plugins": [
              "tbfed-pagefooter"
          ],
          "pluginsConfig": {
              "tbfed-pagefooter": {
                  "copyright": "Copyright &copy zhilidali 2016",
                  "modify_label": "该文件修订时间：",
                  "modify_format": "YYYY-MM-DD HH:mm:ss"
              }
          }
    

  • Toggle Chapters折叠左侧目录 "plugins": ["toggle-chapters"]

  • sectionx页面分块显示"plugins": ["sectionx"]

  • Donate打赏插件

  • multipart将书籍分成几部分

    • 安装$ npm install gitbook-plugin-multipart -g
    • 配置"plugins": [ "multipart" ]
  • Math & Tex
    • 简介
      • mathjax 和 katex 是TeX方程式渲染的两种不同实现,背后代表着开源库: KaTeX和MathJax。
      • MathJax支持所有的TeX语法,但是在电子书(PDF,ePub和Mobi)上的输出不是很完美. KaTeX在所有格式(网站和电子书)渲染的很好,但是至今未能支持所有的语法
    • 引用

            {
                "plugins": ["mathjax"]
            }
      

    • 使用

            这是行级math: $$a \ne 0$$
      

            Here is a block of math:
            $$
            a \ne 0
            $$