本地安裝
GitBook的安裝非常簡單。您的系統只需滿足這兩個要求：
- NodeJS（推薦使用v4.0.0及以上版本）
- Windows，Linux，Unix或Mac OS X
gitbook-cli 是安裝和管理GitBook版本庫的程序。它會自動安裝GitBook所需的模塊來創建一本書。
$ npm install gitbook-cli -g
gitbook使用常見指令：
$ gitbook init // 在當前目錄創建一本書 $ gitbook init ./directory // 用現有的目錄來創建一本書 $ gitbook serve // 預覽創建的書 $ gitbook build // 構建靜態網站 $ gitbook install // 初始化安裝插件
目錄結構
一般GitBook目錄如下：
. ├── book.json ├── README.md ├── SUMMARY.md ├── chapter-1/ | ├── README.md | └── something.md └── chapter-2/ ├── README.md └── something.md
- book.json:配置文件數據
- README.md:簡介-書籍的簡單介紹
- SUMMARY.md:目錄
以子目錄的方式與項目集成
對於軟件項目，可以使用子目錄(如docs/)來存儲項目的文檔。您可以在book.json中通過配置選項告訴GitBook在那里找到根目錄：
. ├── book.json └── docs/ ├── README.md └── SUMMARY.md
book.json配置如下：
{ "root": "./docs" }
菜單與頁面
GitBook使用一個SUMMARY.md文件來定義文檔的菜單。
SUMMARY.md中[]內的內容是標題，()內是文檔的路徑，章節和子章節用四個空格或者tab鍵來分級。
菜單示例：
# 概述 ### 服務介紹 * [服務介紹](README.md) ### 服務接入流程 * [服務開通](serviceOpen.md) * [應用配置](appConfig.md) ### 企業實名認證服務端API * [API服務規范](apiStandard.md) * [營業執照OCR接口](apiOCR.md)
配置
GitBook允許您使用靈活的配置自定義書籍和文檔。這些選項在book.json文件中指定。
常用的配置如下：
{ "root": "./docs", "language" : "zh-hans", "styles": { "website": "./styles/website.css" }, "plugins": [ "hide-element", "back-to-top-button", "chapter-fold", "code", "splitter", "custom-favicon", "insert-logo", "tbfed-pagefooter", "-sharing", "sharing-plus" ], "pluginsConfig": { "hide-element": { "elements": [ ".gitbook-link" ] }, "insert-logo": { "url": "./images/logo.png", "style": "background: none; max-height: 60px; min-height: 50px" }, "favicon": "./images/favicon.ico", "sharing": { "twitter": false, "facebook": false, "google": false }, "tbfed-pagefooter": { "copyright":"北京科技XXX公司版權所有", "modify_label":"該文章修訂時間：", "modify_format": "YYYY-MM-DD HH:mm:ss" } } }
也可以使用gitbook editor編輯markdown文件。
參考地址