Skip to content

Latest commit

 

History

History
106 lines (89 loc) · 2.65 KB

04配置书籍.md

File metadata and controls

106 lines (89 loc) · 2.65 KB

配置书籍

  • book.json或者book.js

    • title 标题,默认使用 README.md 的第一个标题,GitBook.com上创建项目时已填写
    • description 描述,默认使用 README.md 的第一段,GitBook.com上创建项目时已填写
    • author 作者,GitBook.com上创建项目时已填写
    • gitbook 规定生成书籍的GitBook版本号,格式为SemVer标准
    • language 语言,默认是 en
    • isbn 图书ISBN编号
    • direction 文字方向,默认是 rtl
    • styles 样式表,可选 website, ebook, pdf, mobi, epub(pdf , epub , mobi)
    • plugins 插件列表
    • pluginsConfig 配置插件
    • structure 结构:重写readme、langs、summary、glossary文件的路径
    • variables 变量
    • pdf 定制头尾模板,headerTemplate, footerTemplate
    • root 设置除book.json外,其他文件所在的文件夹
  • 替代README.md

     	{
     		"structure": {
     			"readme": "INTRO.md"
     		}
     	}
  • 扩展电子书和站点的样式

    • 例如使<h1> <h2>标签有下边框, 可以在website.css中设置
     	h1 , h2{
     		border-bottom: 1px solid #EFEAEA;
     	}
  • PDF配置

    • pdf.pageNumbers 是否在每页底部添加页码(默认为 true )
    • pdf.fontSize 字体大小基数(默认为 12 )
    • pdf.fontFamily 字体样式(默认为 Arial )
    • pdf.paperSize 页面大小(默认为a4)。可选'a0'和'a1'等
    • pdf.margin.top 顶外边距(默认为 56 )
    • pdf.margin.bottom 底外边距(默认为 56 )
    • pdf.margin.right 右外边距(默认为 62 )
    • pdf.margin.left 左外边距(默认为 62 )

    自定义头部尾部

      ```json
      	{
      		"pdf": {
      			"headerTemplate": "Header of the PDF with _TITLE_",
      			"footerTemplate": "Footer HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and"
      		}
      	}
      ```
    

实例

	{
		"title": "书本的标题",
		"author": "zhilidali",
		"description": "书的描述",
		"language" : "zh-hans",
		"links": {
			"sidebar": {
				"Home": "http://添加左侧导航栏链接.com"
			},
			"gitbook": true
		},
		"structure": {
			"readme": "替换README.md",
			"summary": "替换SUMMARY.md",
			"glossary": "替换GLOSSARY.md",
			"languages": "替换LANGS.md"

		},
		"styles": {
			"website": "styles/website.css",
			"ebook": "styles/ebook.css",
			"pdf": "styles/pdf.css",
			"mobi": "styles/mobi.css",
			"epub": "styles/epub.css"
		},
		"plugins": ["插件名字", "另一个插件名字","-去除自带插件"],
		"pluginsConfig": {
			"fontsettings": {
				"theme": "sepia",
				"family": "serif",
				"size":  1
			}
		},
		"pdf": {
			"fontSize": 16
		},
		"gitbook" : "gitbook版本号SEMVER"
	}