Gitbook book.json

---

1. 简介

配置 GitBook 允许您使用灵活的配置自定义您的书。这些选项在book.json文件中指定。

2. 通用配置

配置名	描述
root	包含所有图书文件的根文件夹的路径，除了book.json
structure	要指定自述文件、摘要、词汇表等的路径。请参阅结构段落。
title	您的书名，默认值是从 README 中提取的。在 legacy.gitbook.com 上，此字段已预先填写。
author	作者姓名。在 legacy.gitbook.com 上，此字段已预先填写。
isbn	书的 ISBN
language	书籍语言的ISO 代码，默认值为en
direction	文本的方向。可以是rtl或ltr，默认值取决于language
gitbook	应该使用的 GitBook 版本。使用SemVer规范并接受如下条件">= 3.0.0"

3. 插件配置

配置名	描述
plugins	要加载的插件列表
pluginsConfig	插件的配置

4. 结构配置

除了root变量之外，您还可以告诉 Gitbook 自述文件、摘要、词汇表、语言的文件名称（而不是使用默认名称，例如README.md）。这些文件必须位于您书籍的根目录（或每本语言书籍的根目录）。dir/MY_README.md不接受诸如此类的路径。

配置名	描述
structure.readme	自述文件名（默认为README.md）
structure.summary	摘要文件名（默认为SUMMARY.md）
structure.glossary	词汇表文件名（默认为GLOSSARY.md）
structure.languages	语言文件名（默认为LANGS.md）

5. PDF配置

PDF 输出可以使用以下中的一组选项进行自定义book.json：

多变的	描述
pdf.pageNumbers	在每页底部添加页码（默认为true）
pdf.fontSize	基本字体大小（默认为12）
pdf.fontFamily	基本字体系列（默认为Arial）
pdf.paperSize	纸张大小，选项为’a0’, ‘a1’, ‘a2’, ‘a3’, ‘a4’, ‘a5’, ‘a6’, ‘b0’, ‘b1’, ‘b2’, ‘b3’, ‘b4’, ‘b5’, ‘b6’, ‘legal’, ‘letter’（默认为a4）
pdf.margin.top	上边距（默认为56）
pdf.margin.bottom	下边距（默认为56）
pdf.margin.right	右边距（默认为62）
pdf.margin.left	左边距（默认为62）

6. 简单示例

gitbook 在编译书籍的时候会读取书籍源码顶层目录中的 book.js或者 book.json，这里以 book.json 为例.

{// Folders to use for output// Caution: it overrides the value from the command line// It's not advised this option in the book.json"output": null,// Generator to use for building// Caution: it overrides the value from the command line// It's not advised this option in the book.json"generator": "site",// Book metadats (somes are extracted from the README by default)"title": null,"description": null,"isbn": null,// For ebook format, the extension to use for generation (default is detected from output extension)// "epub", "pdf", "mobi"// Caution: it overrides the value from the command line// It's not advised this option in the book.json"extension": null,// Plugins list, can contain "-name" for removing default plugins"plugins": [],// Global configuration for plugins"pluginsConfig": {"fontSettings": {"theme": "sepia", "night" or "white","family": "serif" or "sans","size": 1 to 4}},// Variables for templating"variables": {},// Links in template (null: default, false: remove, string: new value)"links": {// Custom links at top of sidebar"sidebar": {"Custom link name": "https://customlink.com"},// Sharing links"sharing": {"google": null,"facebook": null,"twitter": null,"weibo": null,"all": null}},// Options for PDF generation"pdf": {// Add page numbers to the bottom of every page"pageNumbers": false,// Font size for the fiel content"fontSize": 12,// Paper size for the pdf// Choices are [u’a0’, u’a1’, u’a2’, u’a3’, u’a4’, u’a5’, u’a6’, u’b0’, u’b1’, u’b2’, u’b3’, u’b4’, u’b5’, u’b6’, u’legal’, u’letter’]"paperSize": "a4",// Margin (in pts)// Note: 72 pts equals 1 inch"margin": {"right": 62,"left": 62,"top": 36,"bottom": 36},//Header HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_."headerTemplate": null,//Footer HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_."footerTemplate": null}
}

首先，将book.json放到书籍代码顶层目录中，然后编译书籍：

$ gitbook build

可以看到，编译完成，使用

$ gitbook serve

然后将浏览器指向 http://127.0.0.1:4000，可以看到，什么都没有改变！

是的，虽然这里 book.json 文件非法，但是 gitbook build 并没有报错！

<aside>
												


											
gitbook book.json 定制功能相关推荐
	

								
antd pro使用ajax,antd在线换肤定制功能
		
最近react项目,用的antd框架,然后看见他的antdPro例子里面有个定制功能很帅,老大说做,那就做吧,鼓捣了一晚终于实现了. css换肤 入行前端的时候经常看鱼哥(张鑫旭)的博客,记得看过 这 ...
		
						
docsify 构建文档网站之定制功能（全网最全）
		
作者: wugenqiang 学习笔记:https://notebook.js.org/ 微信公众号:码客 E 分享(ID:enjoytoshare) 文档后续更新地址:docsify 构建文档网站  ...
		
						
python读取json配置文件_Python简单读取json文件功能示例
		
本文实例讲述了Python简单读取json文件功能.分享给大家供大家参考,具体如下: read_json.json: { "rule":{ "namespace" ...
		
						
每日新闻丨​百度地图发布语音定制功能​；Windows 10高CPU使用率问题已解
		
更多精彩,请点击上方蓝字关注我们! 每日新闻播报 第09-23期  1 趋势洞察 杨元庆:制造大国变为制造强国 需重视三个转变 近日,联想集团董事长兼CEO杨元庆在2019世界制造业大会上表示,要实现 ...
		
						
js简单实现一个json格式化功能
		
js简单实现一个json格式化功能 背景 html 核心代码 背景 在最近的一个项目中,有个需求是实现json编辑和提交.在我的实现中,使用了在textarea编辑,然后在无序列表中显示json格式化 ...
		
						
修改rcS启动定制功能，后台运行脚本，新建子SHELL进程。
		
除了在rcS中编写了启动所需的必须功能命令后,我们还可以添加自己的定制功能.方法如下: 首先,在/usr/bin下,编写各个定制功能的脚本.注意修改权限 chmod a+x myscript 在脚本里 ...
		
						
android gif第三方,Gboard个性化GIF定制功能终于登陆Android客户端
		
原标题:Gboard个性化GIF定制功能终于登陆Android客户端 据外媒报道,谷歌的第三方键盘Gboard因在Android和iOS流行了一段时间.然而有趣的是,它最新.最酷的功能之一--个性化G ...
		
						
爱说说技术原理:与TXT交互及MDataTable对Json的功能扩展（二）
		
关于爱说说在技术选型的文章见:"爱说说"技术原理方案的定选思考过程 本篇将讲述"爱说说"比较重大的技术问题点及解决手段: 爱说说:http://speak.cy ...
		
						
jmeter实现翻页功能_JMeter定制功能实现
		
jmeter实现翻页功能 JMeter提供了可在采样器中使用的功能. 在编写复杂的测试计划时,您会觉得JMeter缺少某些方法. 您使用Beanshell脚本定义自己的自定义方法. JMeter调用B ...
		
		

					
最新文章
	

						
java连接pg_postgresql 入门（含java、scala连接代码）
		
						
java 继承 注解_在java中实现组合注解原理分析(注解继承)
		
						
oracle 11g安装时提示environment variable:PATH 失败
		
						
【后两个测试点】地下迷宫探索 (30 分)
		
						
u-boot-2011.06-rc2移植到mini2440开发板（一）
		
						
DNS A记录和CNAME记录
		
						
方向导数、梯度与梯度下降
		
						
聚类（1）-- k-means clustering
		
						
两堆草前饿死的驴——选择永远是件痛苦的事
		
						
行业动态_天才、忽悠与炮灰
		
						
java fx设置按钮背景_带透明背景的JavaFX按钮
		
						
算法导论 pdf_[LaTeX 宏包] clrscode3e - 排版《算法导论》风格的伪代码
		
						
大学电路题目怎么搜_大学扫一扫题目出答案软件,可以拍照搜大学题目的app,大学电路分析搜题软件...
		
						
Nacos源码分析-注册中心-Distro
		
						
（总结）Web性能压力测试工具之Siege详解
		
						
三、Logstash安装部署
		
						
【精】LintCode领扣算法问题答案：437. 书籍复印
		
						
【C语言】第五章 - 操作符
		
						
AWB——Complementarity-enhanced Mutual Networks for Unsupervised Domain Adaptation in Person Re-ID
		
						
游戏编辑器制作（4）
		
		
	

热门文章
	

									
Navigation 的应用实践
			
						
js隐藏div vue_vue.js-div怎么隐藏滚动条
			
						
power bi报表html,Power BI 服务中的分页报表
			
						
南开   计算机科学导论,南开计算机科学导论复习-20210614042612.pdf-原创力文档
			
						
linux open: permission denied,Linux运行文件出现“Permission denied”解决办法
			
						
dB dBc dBi dBd dBm dBW 定义
			
						
Linux实验3 服务与进程的管理实验报告（部分英文）
			
						
【2022最新Java面试宝典】—— Spring面试题（75道含答案）
			
						
卡尔曼滤波预测matlab,卡尔曼滤波Matlab示例
			
						
Unity中通过图片加载造成水纹波动的方法(附贴图材质球和脚本)