GitBook配置文件及目录说明

  1. gitbook是一个可以生成web、pdf、ePub、Mobi格式的电子书。

  2. 初始化gitbook之后,需要手动创建两个文件,分别为目录文件SUMMARY.md配置文件book.json

  3. SUMMARY.md介绍
    该文件最终生成的是页面左侧的目录结构。

    # 目录
    * [一级](md文件,必写)
       * [二级](md文件,必写)
          - [三级](md文件,必写)
    

    GitBook配置文件及目录说明_第1张图片

  4. book.json介绍

    {
    	"styles": {
    		"website": "styles/website.css",
    		"pdf": "styles/pdf.css",
    		"mobi": "styles/mobi.css",
    		"epub": "styles/epub.css"
    	},
    	title: "使用说明"
    	structure: {
    		"readme": "README.md"
    	},
    	"plugins": ["", "", ""],
    	"pluginsConfig": {
    	
    	}
    }
    

    ① styles属性用来设置样式,若电子书的格式为网站,则website对应的样式生效;若格式为pdf,则pdf对应的样式生效,以此类推。
    ② title属性为浏览器窗口的标题。
    ③ structure的readme属性对应的md文件可以看做页面加载时第一次进入的页面,一般需要配置在SUMMARY.md中,若未配置,则会在页面左侧导航中自动创建一个introduction目录,作为首页。
    GitBook配置文件及目录说明_第2张图片
    ④ plugins属性用来配置插件,属性值为数组,数组项是插件名称。
    ⑤ pluginsConfig属性可以给plugins中声明的插件设置一些具体的配置信息

你可能感兴趣的:(GitBook,npm,github)