配置

这里主要讲 book.json 的配置及参数,gitbook 使用该文件来配置整本书的基本信息,结构,使用的插件等等信息,这是一个非常重要的配置文件。

这个配置文件使用 json 格式,配置非常简单,参考官方解释即可。

reference

book.json 示例

{
    "plugins": [
        "expandable-chapters"
    ],

    "pluginsConfig": {
        "theme-default": {
             "showLevel": true
        }
    },

    "title": "Python学习",
    "author": "Guohui",
    "links": {
        "sidebar":{
            "个人主页":"https://ghzphy.github.io"
        }
    }
}
  • 第一部分:
"plugins": [
        "expandable-chapters"
    ],

表明左侧目录层次可以折叠。

  • 第二部分:
"pluginsConfig": {
        "theme-default": {
             "showLevel": true
        }
    }

表明给 GitBook 目录编号。

  • 第三部分:
"title": "Python学习",
    "author": "Guohui",

表明文档的标题作者。

  • 第四部分:
"links": {
        "sidebar":{
            "个人主页":"https://ghzphy.github.io"
        }
    }

表明左侧目录内加入'个人主页'部分。