??gitbook 是一個(gè)基于 Node.js 的命令行工具串慰，支持 Markdown 和 AsciiDoc 兩種語(yǔ)法格式，可以輸出 HTML、PDF菜职、eBook 等格式的電子書(shū)。
??gitbook 與 Markdown 和 Git 息息相關(guān)旗闽，只有將它們結(jié)合起來(lái)使用酬核，才能將它們的威力發(fā)揮到極致！通常我們會(huì)選擇合適的 Markdown 編輯工具以獲得飛一般的寫(xiě)作體驗(yàn)适室；使用 GitBook 管理文檔嫡意，預(yù)覽、制作電子書(shū)捣辆；同時(shí)通過(guò) Git 管理書(shū)籍內(nèi)容的變更蔬螟，并將其托管到云端（比如 GitHub、GitLab汽畴、碼云旧巾，或者是自己搭建的 Git 服務(wù)器）耸序，實(shí)現(xiàn)多人協(xié)作。
??相比于word鲁猩，因?yàn)樗远M(jìn)制格式保存坎怪、軟件不兼容、格式不兼容廓握、難以進(jìn)行版本控制搅窿、難以實(shí)時(shí)分享預(yù)覽、難以多人協(xié)作等短板隙券。而這恰恰是 GitBook + Markdown + Git 的長(zhǎng)處男应。
安裝
1、使用npm全局安裝gitbook-cli
npm install gitbook-cli -g
2娱仔、使用gitbook --version來(lái)查看gitbook的版本
gitbook --version
3殉了、新建一個(gè)文件夾，初始化gitbook拟枚，會(huì)自動(dòng)生成兩個(gè)文件薪铜。
README.md —— 書(shū)籍的介紹寫(xiě)在這個(gè)文件里
SUMMARY.md —— 書(shū)籍的目錄結(jié)構(gòu)在這里配置
gitbook init
4、接著恩溅，使用gitbook serve命令來(lái)啟動(dòng)gitbook本地服務(wù)器隔箍，預(yù)覽書(shū)籍內(nèi)容。
gitbook serve
serve 命令也可以指定端口：
gitbook serve --port 2333
5脚乡、打開(kāi)localhost:4000蜒滩，會(huì)出現(xiàn)如下頁(yè)面
6、生成靜態(tài)網(wǎng)頁(yè)
執(zhí)行 gitbook build 命令構(gòu)建書(shū)籍奶稠，默認(rèn)將生成的靜態(tài)網(wǎng)站輸出到 _book 目錄俯艰。實(shí)際上，這一步也包含在 gitbook serve 里面锌订，因?yàn)樗鼈兪?HTML竹握，所以 gitbook 通過(guò) Node.js 提供服務(wù)了。
gitbook build #生成靜態(tài)網(wǎng)頁(yè)
可以生成 PDF 格式的電子書(shū)：
gitbook pdf ./ ./mybook.pdf
生成 epub 格式的電子書(shū)：
gitbook epub ./ ./mybook.epub
生成 mobi 格式的電子書(shū)：
gitbook mobi ./ ./mybook.mobi
如果生成不了辆飘，還需要安裝工具ebook-convert啦辐，安裝好后，還需要執(zhí)行以下命令
ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/local/bin
編輯 SUMMARY.md 文件蜈项，內(nèi)容修改為：
* [快速入門(mén)](README.md)
* 業(yè)務(wù)組件
* [日歷組件](component/rx-touch-calendar/README.md)
* [展示瑞信頭像組件](component/rx-getPhoto-list/README.md)
目錄結(jié)構(gòu)
.
├── README.md
├── SUMMARY.md
├── book.json
├── component
│ ├── rx-getPhoto-list
│ └── rx-touch-calendar
└── style.css
book.json芹关，該文件用于存放配置信息。
【title】書(shū)本的標(biāo)題
【author】作者的相關(guān)信息
【description】本書(shū)的簡(jiǎn)單描述
【language】gitbook使用的語(yǔ)言
【root】指定存放 GitBook 文件（除了 book.json）的根目錄
【structure】指定自述文件紧卒，摘要侥衬，詞匯表等的路徑
gitbook支持許多插件，可以擴(kuò)展gitbook的功能。
【打賞功能：donate】
{
"plugins": ["donate"],
"pluginsConfig": {
"donate": {
"wechat": "例：/images/qr.png",
"alipay": "http://blog.willin.wang/static/images/qr.png",
"title": "默認(rèn)空",
"button": "默認(rèn)值：Donate",
"alipayText": "默認(rèn)值：支付寶捐贈(zèng)",
"wechatText": "默認(rèn)值：微信捐贈(zèng)"
}
}
}
【廣告功能：ad】
{
"plugins": ["ad"],
"pluginsConfig": {
"ad": {
"contentTop": "<div>Ads at the top of the page</div>",
"contentBottom": "%3Cdiv%3EAds%20at%20the%20bottom%20of%20the%20page%3C/div%3E"
}
}
}
// note: contentBottom is escape('<div>Ads at the bottom of the page</div>')
【目錄寬度可調(diào)節(jié)：splitter】
{
"plugins": ["splitter"]
}
【github圖標(biāo)】
{
"plugins": [ "github" ],
"pluginsConfig": {
"github": {
"url": "https://github.com/your/repo"
}
}
}
【自定義頁(yè)腳：tbfed-pagefooter】
{
"plugins": [ "tbfed-pagefooter" ],
"pluginsConfig": {
"tbfed-pagefooter": {
"copyright":"© Taobao FED Team",
"modify_label": "該文件修訂時(shí)間：",
"modify_format": "YYYY-MM-DD HH:mm:ss"
}
}
}
【目錄章節(jié)可折疊：expandable-chapters】
{
{
plugins: ["expandable-chapters"]
}
{
"pluginsConfig": {
"expandable-chapters":{}
}
}
}
【暢言評(píng)論：changyan】
{
"plugins": [
"changyan"
],
"pluginsConfig": {
"changyan": {
"appid": "your changyan's appid",
"conf": "the conf in the code generate by changyan"
}
}
}
【返回頂部：back-to-top-button】
{
"plugins" : [ "back-to-top-button" ]
}
??上面支持列舉了一些常用的插件轴总，想要了解更多可以閱讀官方文檔贬媒，插件在book.json配置好后，需要安裝肘习。
sudo gitbook install
book.json模板
{
"title": "UI",
"description": "UI組件庫(kù)",
"author": "zhuyongbo",
"language": "zh-hans",
"links": {
"sidebar": {
"開(kāi)放平臺(tái)": "http://e.cnpc.com.cn/opensdk/"
}
},
"styles":{
"website":"style.css"
},
"plugins": [
"-lunr",
"-search",
"-livereload",
"-sharing",
"expandable-chapters",
"search-plus",
"splitter",
"github",
"-sharing",
"emphasize",
"include-codeblock",
"tbfed-pagefooter",
"back-to-top-button",
"anchor-navigation-ex"
],
"pluginsConfig": {
"github": {
"url": "https://github.com/webzhuyongbo"
},
"sharing": {
"douban": false,
"facebook": false,
"google": false,
"hatenaBookmark": false,
"instapaper": false,
"line": false,
"linkedin": false,
"messenger": false,
"pocket": false,
"qq": false,
"qzone": false,
"stumbleupon": false,
"twitter": false,
"viber": false,
"vk": false,
"weibo": false,
"whatsapp": false,
"all": [
"weibo","qq","qzone","google","douban"
]
},
"anchor-navigation-ex": {
"associatedWithSummary":false,
"showLevel":true,
"multipleH1": true,
"mode": "float",
"pageTop": {
"showLevelIcon": false,
"level1Icon": "fa fa-hand-o-right",
"level2Icon": "fa fa-hand-o-right",
"level3Icon": "fa fa-hand-o-right"
}
},
"tbfed-pagefooter": {
"copyright": "©北京信息技術(shù)有限責(zé)任公司",
"modify_label": "文檔更新時(shí)間：",
"modify_format": "YYYY-MM-DD HH:mm:ss"
}
}
}
去掉gitbook的版權(quán)信息：
創(chuàng)建樣式表文件“styles/website.css”际乘，添加代碼如下：
.gitbook-link {
display: none !important;
}
編輯“book.json”文件，添加如下代碼：
{
"styles": {
"website": "styles/website.css"
}
}
好了漂佩，讓我們看一下我們文檔的效果圖脖含。
