配置

对一本书的所有设定,都以 JSON 格式写在 book.json 文件中。

你可以把 book.json 文件的内容复制贴到 jsonlint.comarrow-up-right 检查 JSON 语法是否正确。

所有栏位都有多种选项,以及特定的预设值。

gitbook

 "gitbook": ">=2.0.0"

此选项用来检查使用 GitBook 哪个版本来制作书籍,版本号的格式遵循 SEMVER](http://semver.orgarrow-up-right) 的规范。

title

 "title": "My Book"

设置书籍名称,默认值是README.md文件的第一个标题

description

 "description": "This is such a great book!"

书籍的简介,默认值是README.md文件中的第一个段落内容。

author

作者的相关信息

isbn

书籍的ISBN

language

定义书籍使用的主要语言文字,默认值是 en (英文)。

也会用来设定国际与本地化,例如网站介面使用的文字会连带变换语系。

gitbook.com 网站上,这个值可以在设定介面中指定,否则就会根据内容自动侦测。

direction

这个选项用来覆盖掉语言预设的阅读走向,由左到右(ltr)或由右到左(rtl),建议依据语言特性设定正确,例如阿拉伯语系文字都是由右到左;而中文设定 rtl 则是直排专用,目前 GitBook 并不支援。

styles

自定义页面样式, 默认情况下各generator对应的css文件

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

variables

这选项用来定义[模板](https://wastemobile.gitbooks.io/gitbook-chinese/content/format/(./templating.md)中要使用到的变数与值。arrow-up-right

root

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

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

plugins

配置使用的插件

添加新插件之后需要运行gitbook install来安装新的插件

Gitbook默认带有5个插件:

  • highlight

  • search

  • sharing

  • font-settings

  • livereload

如果要去除自带的插件, 可以在插件名称前面加-

pluginsConfig

配置插件的属性

structure

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

变量

含义和默认值

structure.readme

Readme file name (defaults to README.md)

structure.summary

Summary file name (defaults to SUMMARY.md)

structure.glossary

Glossary file name (defaults to GLOSSARY.md)

structure.languages

Languages file name (defaults to LANGS.md)

例如你想用 INTRO.md 而不是 README.md 撰写书籍介绍:

可以改变的架构设定有: readme, langs, summaryglossary

建议没事不要变更这些设定比较好,程式有时不那么聪明,正常运作最重要。

Last updated