gitbook 入门

安装 gitbook 插件

npm install gitbook-cli -g  或者  yarn global add gitbook-cli

初使化目录

gitbook init

会发现目录下面多了2个文件，README.md和SUMMARY.md

README.md 和 SUMMARY.md 是两个必须文件

README.md 是对书籍的简单介绍

SUMMARY.md 是书籍的目录结构

生成

gitbook build   //生成在当前目录的默认文件夹 _book里面

gitbook build  ./out      //生成在当前目录的默认文件夹 指定的out 里面

gitbook build  ./md  ./out   //当前md外  生成out

本地预览

gitbook serve

http://localhost:4000

配置文件（不是必需的）

{
	"title": "前端规范",
	"description": "前端规范 简介",
	"language": "zh-hans",
	"plugins": [

	],
	"pluginsConfig": {

	},
	"links": {
		"gitbook": false,
		"sharing": {
			"google": false,
			"facebook": false,
			"twitter": false,
			"all": false
		}
	}
}

设置语言、去掉分享功能

重要说明：gitbook 如果要安装插件 要安插件的路径为 win C:\Users\admin.gitbook\versions\3.2.2 其他系统不知道

eg:

本人的配置文件

{
	"title": "前端规范",
	"description": "前端规范 简介",
	"language": "zh-hans",
	"plugins": [
		"-lunr",
		"-search",
		"search-plus",       //支持中文搜索  上面 search 是默认的   “-”  是去掉的意思
		"splitter",               // 这个侧边可以拉伸
		"tbfed-pagefooter",    //这个是底部加 信息  下面可以看到具体的配置
		"expandable-chapters-small"     //使左侧的章节目录可以折叠
	],
	"pluginsConfig": {
        "theme-default": {
	        "showLevel": true
	    },
	    "tbfed-pagefooter": {
	        "copyright":"Copyright &copy xxxxx",
	        "modify_label": "该文件修订时间：",
	        "modify_format": "YYYY-MM-DD HH:mm:ss"
	    }
	},
	"links": {
		"gitbook": false,
		"sharing": {
			"google": false,
			"facebook": false,
			"twitter": false,
			"all": false
		}
	}
}

可以参考：http://gitbook.zhangjikai.com/plugins.html