20170125 創(chuàng)建說明
使用Gitbook生成在線文檔的流程:
- 本機安裝Node.js環(huán)境;
- 安裝GitBook;
- 生成本地文檔文件;
- 編輯本地文檔;
- 構(gòu)建靜態(tài)頁面;
- 將靜態(tài)頁面推送到GitHub Pages服務(wù);
- 訪問對應(yīng)url。
注:Node.js環(huán)境只用于本機生成&編譯App和靜態(tài)頁面,如果使用服務(wù)端自建git,服務(wù)端無需安裝Node.js環(huán)境,只需同步靜態(tài)頁面后,用其他web容器訪問靜態(tài)頁面即可。
配置流程
在 https://nodejs.org/ 下載并安裝Node.js
安裝GitBook,終端輸入
npm install gitbook-cli -g
- 創(chuàng)建書本文件夾,初始化文件目錄
gitbook init
- 編輯SUMMARY.md文件,生成目錄結(jié)構(gòu)
- 再次執(zhí)行
gitbook init
生成文件目錄 - 編輯其他.md文件,并在編輯結(jié)束后,執(zhí)行
gitbook init
- 編輯中預(yù)覽效果,執(zhí)行
gitbook serve
- 創(chuàng)建靜態(tài)頁
gitbook build
生成_book
目錄
- 使用git將所有文件夾/僅_book文件夾同步至網(wǎng)絡(luò)服務(wù)
- 訪問對應(yīng)url。
注:推薦使用類GitHub Pages服務(wù)。
GitBook開源地址:https://github.com/GitbookIO/gitbook
GitBook安裝說明:https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md