一、书本配置

1. 书本标题：title

    "title" : "This Gitbook"

2. 作者：author

    "author" : "Monky"

3. 简单描述：description

    "description" : "记录Gitbook插件配置和使用方法"

4. 语言：language

    Gitbook使用的语言, 版本2.6.4中可选的语言如下：
    en, ar, bn, cs, de, en, es, fa, fi, fr, he, it, ja, ko, no, pl, pt, ro, ru, sv, uk, vi, zh-hans, zh-tw
    
    例如，配置使用简体中文
    "language" : "zh-hans"

5. 左侧导航栏添加链接信息：links

    "links" : {
        "sidebar" : {
            "Home" : "https://www.baidu.com"
        }
    }

6. 自定义页面样式

• 默认情况下各generator对应的css文件

    "styles": {
        "website": "styles/website.css",
        "ebook": "styles/ebook.css",
        "pdf": "styles/pdf.css",
        "mobi": "styles/mobi.css",
        "epub": "styles/epub.css"
    }

• 例如使 <h1> <h2>标签有下边框， 可以在website.css中设置

    h1 , h2{
        border-bottom: 1px solid #EFEAEA;
    }

二、插件配置

1. 配置使用的插件

    "plugins": [
        "-search", "-share"
        "back-to-top-button",
        "expandable-chapters-small",
        "insert-logo"
    ]
    
    
    其中"-search"中的 - 符号代表去除插件

• Gitbook默认自带有5个插件：
  • highlight： 代码高亮
  • search： 导航栏查询功能（不支持中文）
  • sharing：右上角分享功能
  • font-settings：字体设置（页面顶部的"A"符号）
  • livereload：为GitBook实时重新加载（不建议）

2. 插件属性配置pluginsConfig

• 配置插件的属性，例如配置 tbfed-pagefooter(页脚插件) 的属性：

    "plugins": [
       "tbfed-pagefooter"
    ],

    "pluginsConfig": {
        "tbfed-pagefooter": {
            "copyright":"Copyright &copy xxxx.com 2020",
            "modify_label": "该文件修订时间：",
            "modify_format": "YYYY-MM-DD HH:mm:ss"
        }
    }

三、常用插件

• 用法：在book.json中添加 "plugins" 和 "pluginConfig" 字段。然后执行 gitbook install，或者使用NPM安装npm install gitbook-plugin-插件名，也可以从源码GitHub地址中下载，放到 node_modules文件夹里。

1. 回到顶部：back-to-top-button

    "plugins": [
        "back-to-top-button"
    ]

2. 导航目录折叠

• 插件1：chapter-fold

    "plugins": [
        "chapter-fold"
    ]

注意：要想目录折叠，SUMMARY.md目录应该如下：

    * [引言](README.md)
    
    * [第一章](book/season1/season1.md)
        * [第一节](book/season1/chapter1.md)
        * [第二节](book/season1/chapter2.md)
    * [第二章](book/season2/season2.md)
        * [第一节](book/season2/chapter1.md)
        * [第二节](book/season2/chapter2.md)

如下写法会产生bug，点击目录无法展开列表:

    * [第一章]
        * [第一节](book/season1/chapter1.md)
        * [第二节](book/season1/chapter2.md)

• 插件2：expandable-chapters

    "plugins": [
        "expandable-chapters"
    ]

注意：如下写法，需要点击箭头才能展开收缩目录：

    * [第一章](book/season1/season1.md)
        * [第一节](book/season1/chapter1.md)
        * [第二节](book/season1/chapter2.md)

建议：和chapter-fold插件一起用：

    "plugins": [
        "expandable-chapters",
        "chapter-fold",
    ]

3. 侧边栏(侧边目录)宽度可调节：splitter

    "plugins": [
        "splitter"
    ]

4. 查看图片

• 新标签页打开图片，查看原图：popup

    "plugins": [
        "popup"
    ]

• 以弹窗形式查看图片，查看原图：lightbox

    "plugins": [
        "lightbox"
    ]

5. 页面内导航目录

• 在页面顶部显示目录：page-treeview

    "plugins": [
        "page-treeview"
    ]

• 页面内生成悬浮导航目录：anchor-navigation-ex

    "plugins": [ 
        "anchor-navigation-ex"
    ],
    "pluginsConfig": {
        "anchor-navigation-ex": {
            "showLevel": false,     // 标题是否显示标题层级序号
            "showGoTop": false      // 是否显示返回顶部按钮
        },
    }   

• 页面右上角生成黑色的按钮，鼠标移入后会显示黑色的目录：page-toc-button
  建议：该插件与“back-to-top-button(回到顶部)”一起使用，可实现快速定位。

    "plugins": [ 
        "page-toc-button"
    ],

    "pluginsConfig": {
        "page-toc-button": {
            "maxTocDepth": 2,  // 标题的最大深度（2 = h1 + h2 + h3）。不支持值> 2。
            "minTocSize": 2    // 显示toc按钮的最小toc条目数。
           }
    }

• 页面右上角悬浮导航以及回到顶部按钮：ancre-navigation

    "plugins": [
        "ancre-navigation"
    ]

6. 修改网站图标，浏览器标签栏上的小图标和保存后书签的图标

• 注意：
  1、图标的格式一定要是.ico的，直接修改图片的后缀为.ico是无效的。
  2、图标的分辨率要是32x32的。
• 插件1：favicon

    "plugins": [
        "favicon"
    ],

    "pluginsConfig": {
        "favicon": {
            "shortcut": "file/favicon.ico",
            "bookmark": "file/favicon.ico",
        }
    }

• 插件2：custom-favicon

    "plugins": [
        "custom-favicon"
    ],
    
    "pluginsConfig" : {
        "favicon": "file/favicon.ico"
    }

7. 页面添加页脚，包含版本信息和文档最后修订时间：tbfed-pagefooter

    "plugins": [
       "tbfed-pagefooter"
    ],

    "pluginsConfig": {
        "tbfed-pagefooter": {
            "copyright":"Copyright &copy xxxx.com 2020",
            "modify_label": "该文件修订时间：",
            "modify_format": "YYYY-MM-DD HH:mm:ss"
        }
    }

8. 隐藏元素，元素可以通过检查页，查找对应的class获取：hide-element

    "plugins": [
        "hide-element"
    ],

    "pluginsConfig": {
        "hide-element": {
            "elements": [".gitbook-link", ".copyright"]
        }
    }

9. 在左侧栏上方插入公司/团队logo：insert-logo

    "plugins": [
        "hide-element"
    ],
    
    "pluginsConfig": {
        "insert-logo": {
            "url": "file/logo.png",
            "style": "background: none; max-height: 30px; min-height: 30px"
        }
    }

10. 高级搜索（支持中文）：search-pro，需要将默认的search和lunr 插件去掉

    "plugins": [
        "-lunr", 
        "-search", 
        "search-pro"
    ]

11. 阅读量计数：pageview-count

    "plugins": [
        "pageview-count"
    ]