GitBook

　　GitBook 提供以下功能。

• 支持 markdown 語法
• 自動構建文檔網站
• 豐富的插件來拓展網站，比如：搜索，代碼高亮等
• 支持 git 進行文檔項目管理

什么是 GitBook

　　GitBook 是一個文檔編輯工具。它的功能類似金山的 WPS，微軟的 Office 中的 Word 文檔編輯工具。它可以用來寫文檔、建表格、插圖片、生成 pdf 。雖然這些功能不一定有 WPS、Office 做得好，但是它可以用文檔生成一個網站，讓更多的人了解到你書寫的內容。從此，不再為共享文檔給他人后，如何時時同步而煩惱。實例效果如下：

GitBook 官網注冊登錄后，可在線創建、編輯和發布文檔。線下提供離線編輯工具 GitBook Editor。但是本文檔主要講解的是 ，如何利用 GitBook 的命令行工具 gitbook-cli 來創建、預覽及發布文檔。

安裝 gitbook-cli

NodeJs

　　安裝 NodeJs 是因為我們要使用其提供的 npm 包管理工具來下載安裝 gitbook-cli。從 NodeJs 官網 下載最新版本安裝即可（版本要求 V4.0.0 及以上）。

安裝 gitbook-cli

　　運行以下命令進行安裝

npm install gitbook-cli -g

gitbook init 項目初始化

　　首先新建如下目錄結構

README.md 和 SUMMARY.md 是兩個必須文件。
- README.md： 是對書籍的簡單介紹

鼎盛云開放平臺 H5 接口文檔

• SUMMARY.md：是書籍的目錄結構

# Summary* [Introduction](README.md) * [1、接口規則](chapter1/README.md) * [1.1、協議規則](chapter1/section1.1.md) * [1.2、公共參數](chapter1/section1.2.md) * [1.3、其它說明](chapter1/section1.3.md) * [1.3.1、其它說明](chapter1/section1.3.1.md) * [2、用戶](chapter2/README.md) * [2.1、手機號查詢用戶注冊狀態](chapter2/section2.1.md) * [2.2、用戶注冊-短信下發](chapter2/section2.2.md) * [2.3、用戶注冊-短信驗證](chapter2/section2.3.md) * [2.4、驗證交易密碼](chapter2/section2.4.md) * [2.5、是否關聯身份信息-手機號](chapter2/section2.5.md) * [2.6、設置賬單日](chapter2/section2.6.md)

注意星號”*” 后面有個空格，忽略此會直接導致文檔生成失敗。

創建完這兩個文件后，在文檔根目錄運行一下命令，初始化項目（gitbook 會幫我們生成 SUMMARY.md 中的目錄結構）

gitbook init

gitbook serve 編輯預覽

　　書籍目錄結構創建完成以后，就可以使用命令 gitbook serve 來預覽書籍了。打開瀏覽器，輸入http://localhost:4000查看書籍效果。當然，文檔的具體內容，就有待自己去添加了。建議使用 markdown 語法，這里為小白提供一個markdown 簡單教程;

gitbook build 發布圖書

　　通過執行 gitbook build 命令，gitbook 會在根目錄下面生成一個編譯打包后的文件 _book 里面便是我們文檔編譯后生成的 html 網頁。后面便是，通過 ngnix 托管，讓其在互聯網上可見。

Glossary 詞匯解釋

　　詞匯表文件，默認對應根目錄下的 GLOSSARY.md 。該文件主要存儲詞匯信息，如果在其它頁面中出現了該文件中的詞匯，鼠標放在詞匯上會給出詞匯解釋。
　　Glossary 文件的格式如下所示：

## API 接口說明文檔## Markdown 排版語言，程序員專屬

這里是兩個 ## 。

book.json 文檔配置信息說明文件

　　存放在根目錄，記錄文檔項目的一些說明信息，及最后項目打包的配置信息。格式如下：

{title:"文檔名稱",author:"作者1;作者2",description:"文檔描述",language:"使用的語言,英語、簡體中國等",gitbook:">=3.2.2", // gitbook 的版本root:".",// 指定存放 GitBook 文件的根目錄links:"左側邊欄添加鏈接" ,styles:"指定打包生成網頁的樣式",plugins:"指定打包生成網頁需要使用的插件",pluginsConfig:"配置插件的屬性", }

language

　　GitBook 使用的語言，簡體中文配置如下：

"language":"zh-hans"

links

　　在左側導航欄添加鏈接信息

"links":{"sidebar":{"Home":"http://localhost:4000"} }

styles

　　自定義頁面樣式，默認情況下各 generator 對應的 css 文件

"styles":{"website":"styles/website.css","ebook":"styles/ebook.css", "pdf":"styles/pdf.css","mobi":"styles/mobi.css","epub":"styles/epub.css", }

plugins

　　配置使用的插件

"plugins":["disqus" ]

添加新插件之后，需要運行 gitbook installl 來安裝新插件
GitBook 默認帶有 5 個插件 highlight，search，sharing，font-settings，livereload。如果要去除自帶的插件，可以在插件名稱前面加 - 如下：

"plugins":["-search" ]

更多可選插件，可在插件官網查看。常見插件使用

pluginsConfig

　　配置插件的屬性

"pluginsConfig":{"fontsettings":{"theme":"sepia","family":"serif""size":1} }

總結

以上是生活随笔為你收集整理的GitBook 告别文档共享烦恼的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。