基础配置

所有的配置都以 JSON 格式存储在名为 book.json 的文件中。

title

设置书本的标题

"title" : "Gitbook 使用"

author

作者的相关信息

"author" : "zha0cai"

description

本书的简单描述，默认是从 README（第一段）中提取的。

"description" : "码谱 & zha0cai 整理的 Gitbook 的配置和使用"

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"

gitbook

这个选项是用来指定生成书本的 GitBook 的版本的。

"gitbook" : "3.2.2",
"gitbook" : ">=3.0.0"

root

指定存放 GitBook 文件（除了 book.json）的根目录

"root": "."

"root": "./docs"

links

在左侧导航栏添加链接信息

{"links" : {
    "sidebar" : {
        "首页" : "https://zha0cai.github.io/gitbookPublic/home/"
    }
}}

styles

自定义页面样式， 默认情况下各 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;
}

plugins

配置使用的插件

{
"plugins": [
    "github"
]}

添加新插件之后需要运行 gitbook install 来安装新的插件，建议使用 npm install gitbook-plugin-xxx 来安装对应插件。

Gitbook 默认带有 7 个插件：

• livereload 热加载插件
• highlight 语法高亮插件
• search 搜索插件
• lunr 搜索插件后台服务
• sharing 分享插件
• fontsettings 字体设置插件
• theme-default 主题

如果要去除自带的插件， 可以在插件名称前面加 - 例如，移除搜索 search 插件：

{
    "plugins": [
        "-search"
    ]
}

pluginsConfig

配置插件的属性

{
    "pluginsConfig": {
        "fontsettings": {
            "theme": "sepia",
            "family": "serif",
            "size":  1
        }
    }
}

structure

指定 Readme、Summary、Glossary 和 Languages 对应的文件名，下面是这几个文件对应变量以及默认值：

variables

{
    "variables": {
        "firstbook": "Hello World"
    }
}

这个选项定义在 模板 中使用的变量值。