Configuration
GitBook允许您使用灵活的配置来自定义您的图书。这些选项在book.json文件中指定。对于不熟悉JSON语法的作者，可以使用JSONlint等工具验证语法。
General Settings
| 变量 | 描述 |
|---|---|
root |
指定存放 GitBook 文件（除了 book.json）的根目录"root": "." |
structure |
指定自述文件，摘要，词汇表等的路径请参见结构段落。 |
title |
设置书本的标题 "title" : "Gitbook Use" |
description |
本书的简单描述 "description" : "记录Gitbook的配置和一些插件的使用" |
author |
作者的相关信息 "author" : "user" |
isbn |
ISBN of the book |
language |
Gitbook使用的语言 "language" : "zh-hans", 可选的语言如下：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 |
direction |
Text's direction. Can be rtl or ltr, the default value depends on the value of language |
gitbook |
指定使用的gitbook版本 "gitbook" : "3.2.3", |
Plugins
插件及其配置在book.json中指定。有关更多详细信息，请参见插件部分。自3.0.0版以来，GitBook可以使用主题。
有关更多详细信息，请参见主题部分。
| 变量 | 描述 |
|---|---|
plugins |
配置使用的插件 |
pluginsConfig |
配置插件的属性 |
plugins
配置使用的插件
"plugins": [
"disqus"
]
添加新插件之后需要运行gitbook install来安装新的插件
Gitbook默认带有5个插件：
- highlight
- search
- sharing
- font-settings
- livereload
如果要去除自带的插件， 可以在插件名称前面加-
"plugins": [
"-search"
]
pluginsConfig
配置插件的属性
"pluginsConfig": {
"fontsettings": {
"theme": "sepia",
"family": "serif",
"size": 1
}
}
结构
指定 Readme、Summary、Glossary 和 Languages 对应的文件名，下面是这几个文件对应变量以及默认值：
| 变量 | 描述 | 默认值 |
|---|---|---|
structure.readme |
Readme file | README.md |
structure.summary |
Summary file | SUMMARY.md |
structure.glossary |
Glossary file | GLOSSARY.md |
structure.languages |
Languages file | LANGS.md |
PDF Options
可以使用book.json中的一组选项来定制PDF输出：
| 变量 | 描述 |
|---|---|
pdf.pageNumbers |
Add page numbers to the bottom of every page (default is true) |
pdf.fontSize |
Base font size (default is 12) |
pdf.fontFamily |
Base font family (default is Arial) |
pdf.paperSize |
Paper size, options are 'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'legal', 'letter' (default is a4) |
pdf.margin.top |
Top margin (default is 56) |
pdf.margin.bottom |
Bottom margin (default is 56) |
pdf.margin.right |
Right margin (default is 62) |
pdf.margin.left |
Left margin (default is 62) |
links
在左侧导航栏添加链接信息
"links" : {
"sidebar" : {
"Home" : "http://zhangjikai.com"
}
}
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;
}