gitbook--好用的编写API文档工具

参考资料：http://gitbook.zhangjikai.com/index.html

创建一个gitbook仓库包含基本的文件：

.gitignore

SUMMARY.md（撰写左边导航栏）

README.md（简介）

book.json（对gitbook基本的配置，有的时候你一个这样的仓库，可能没有该文件，可自行创建）

遇到的坑：请使用gitbook2.6.7版本，使用最新版本3点几的话，出现了左边导航栏链接点击无效的问题。

如何指定当前构建gitbook版本？可以通过book.json来指定。

看下book.json的配置：

{
"title": "这只是个demo",
"description": "这只是个demo",
"author": "i am beauty",
"language": "zh-hans",
"gitbook": "2.6.7",
"fontState": {
"size": "2",
"family": "sans",
"theme": "night"
},
"links": {
"sidebar": {
"Gitbook官网": "https://www.gitbook.com"
}
},
"plugins": [
"splitter",
"-sharing",
"-search",
"expandable-chapters"
],
"pluginsConfig": {
"search-pro": {
"cutWordLib": "nodejieba",
"defineWord": [
"这只是个demo"
]
}
}
}

具体的属性介绍请看：

http://gitbook.zhangjikai.com/settings.html

这里我多介绍一个如何让你的gitbook高大上的配置，就是刚刚代码里的一段，主要是设置了黑色背景，是不是很装逼！！！：

"fontState": {
"size": "2",
"family": "sans",
"theme": "night"
}

另外gitbook中还有些很好用的plugin。

如何看到自己使用的plugin呢？？当你gitbook build好网页之后，你可以按f12查看，例如



那如何指定要使用的plugin呢？当然还是在gitbook中了

具体可以看http://gitbook.zhangjikai.com/plugins.html

介绍两个简单的，例如expandable-chapters和toggle-chapters，主要是对左边栏折叠，两者的区别请看下图：


上图是expandable-chapters，如果是toggle-chapters就是没有折叠箭头符号，并且当前只有一项可以展开