GitBook for Mac
GitBook 是一個(gè)基于 Node.js 的命令行工具闸盔，可使用 Markdown 來制作精美的電子書扳还。
公司采用 GitBook 為接口文檔撰寫工具哄陶。
Mac 下安裝 GitBook
- Mac 需要先安裝 Homebrew
安裝方法及地址： http://brew.sh/index_zh-cn.html - 使用 Homebrew 安裝Node.js
使用終端運(yùn)行：
brew install node - 使用 npm 安裝 gitbook :
npm install -g gitbook-cli --registry=https://registry.npm.taobao.org
使用 淘寶源 或 翻墻 (Mac 下推薦魚擺擺 https://ybb1024.com)
Win 下安裝 GitBook
- Win 需要先安裝 Node.js
安裝包下載地址： https://nodejs.org/en/download/
選擇 Windows Installer (.msi) 相應(yīng)版本下載帆阳； - 使用 npm 安裝 gitbook :
打開 cmd 運(yùn)行:
npm install -g gitbook-cli --registry=https://registry.npm.taobao.org
使用 GitBook
新建一個(gè)文件夾，如 XuhaiBook
使用終端進(jìn)入 XuhaiBook
打開終端輸入cd 空格屋吨，將新建文件夾拖入終端界面中蜒谤，回車進(jìn)此文件夾；初始化 GitBook
在終端中輸入gitbook init
命令執(zhí)行完畢后在 XuhaiBook 文件夾中會(huì)生成兩個(gè)文件:
README.md - GitBook的主頁.
SUMMARY.md - 定義了GitBook的結(jié)構(gòu). 它包含章節(jié)的列表,以及它們的鏈接.-
編寫 GitBook
GitBook 使用的語法為 MarkDown至扰，可以使用 Mou 或 GitBook Editor 進(jìn)行編輯
SUMMARY.md 示例：* [XXX接口文檔](README.md) * 個(gè)人信息 * [登錄](登錄.md) * [注冊(cè)](注冊(cè).md) * [獲取驗(yàn)證碼](獲取驗(yàn)證碼.md) * 地址管理 * [地址列表](地址列表.md) * [修改地址](修改地址.md)
在 XuhaiBook 中新建 xx.md 使用 MarkDown 語法編輯即可
- 文檔生成
終端 cd 進(jìn)入 XuhaiBook
gitbook 生成文檔命令:
gitbook serve
執(zhí)行完畢后可以使用提示的 http 地址進(jìn)行訪問鳍徽，也可以打開 XuhaiBook/_book/index.html 進(jìn)行查看；
生成靜態(tài)網(wǎng)站：
gitbook build
如果想要轉(zhuǎn)換成PDF敢课，需先下載安裝 calibre 地址：http://calibre-ebook.com/download :
gitbook pdf
可以在根目錄添加 index.html 文件方便他人查看:
<!doctype html>
<html>
<head>
<meta http-equiv="refresh" content="0;url=./_book/index.html">
</head>
</html>
