配置书籍

  • 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

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

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

      1. h1 , h2{
      2. border-bottom: 1px solid #EFEAEA;
      3. }
  • 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 )

      自定义头部尾部

      1. {
      2. "pdf": {
      3. "headerTemplate": "Header of the PDF with _TITLE_",
      4. "footerTemplate": "Footer HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and"
      5. }
      6. }

实例

  1. {
  2. "title": "书本的标题",
  3. "author": "zhilidali",
  4. "description": "书的描述",
  5. "language" : "zh-hans",
  6. "links": {
  7. "sidebar": {
  8. "Home": "http://添加左侧导航栏链接.com"
  9. },
  10. "gitbook": true
  11. },
  12. "structure": {
  13. "readme": "替换README.md",
  14. "summary": "替换SUMMARY.md",
  15. "glossary": "替换GLOSSARY.md",
  16. "languages": "替换LANGS.md"
  17. },
  18. "styles": {
  19. "website": "styles/website.css",
  20. "ebook": "styles/ebook.css",
  21. "pdf": "styles/pdf.css",
  22. "mobi": "styles/mobi.css",
  23. "epub": "styles/epub.css"
  24. },
  25. "plugins": ["插件名字", "另一个插件名字","-去除自带插件"],
  26. "pluginsConfig": {
  27. "fontsettings": {
  28. "theme": "sepia",
  29. "family": "serif",
  30. "size": 1
  31. }
  32. },
  33. "pdf": {
  34. "fontSize": 16
  35. },
  36. "gitbook" : "gitbook版本号SEMVER"
  37. }