Gitbook是一個很優秀的社區，上面有不少優秀的做者自出版本身的著做，就好像Leanpub，可能不少人喜歡Leanpub，可是我仍是喜歡Gitbook，這種相似於Github的原創社區。同時Gitbook還提供一個開源的配套的工具。也許看到此文章的不少人很早就知道Gitbook，可是也許你沒有使用過，如今Gitbook已經比較成熟了，功能也比較完善。下面咱們首先來介紹下Gitbook的使用。git
Gitbook的使用
當你使用Gitbook的時候，新建一個項目的時候，會彈出下面選項，共四種類型的模板提供給你選擇，實際上他們沒什麼區別，只是一個Markdown模板：
github
咱們選擇了第一項，固然，初次嘗試的朋友，能夠都選擇看一看不一樣的Markdown模板。api
如圖所示， Gitbook Editor，實際上就是一個特殊的Markdown編輯器。我建立了一個test項目做爲示例，你也能夠本身建立一本新書，而後打開源目錄，會看到以下文件：mvc
- _book 文件夾
- SUMMARY.md
- README.md
SUMMARY.md 這個文件就是書的目錄結構。Gitbook Editor對中文支持不太好，有時候你用Editor建立了一個章節，用中文命名，可是當你點擊那個新建的章節的時候，會報錯，解決辦法就是用你本身的編輯器打開這個文件，直接編輯這個文件就行了。app
具體Editor如何上手，就不詳細說了，相信你會用Markdown編輯器就會用Editor。框架
當你建立了一本書以後，能夠經過「Book->Publish As...」功能來把你的書發佈到Gitbook，可是前提是你必需要在Gitbook網站上面也相應建立好這本書。編輯器
你也能夠經過使用Gitbook的幫助，使用Git來建立並上傳你的書：工具
touch README.md SUMMARY.md
git init
git add README.md SUMMARY.md
git commit -m "first commit"
git remote add gitbook https://push.gitbook.io/blackanger/test.git
git push -u gitbook master
…or push an existing repository from the command linepostgit remote add gitbook https://push.gitbook.io/blackanger/test.git
git push -u gitbook master網站
你也能夠在本地使用Editor的Preview Website功能，在本地_books目錄中生成靜態網頁，也就是書的Web版本。 早先的Gitbook Editor版本能夠直接在本地生成epub、pdf、mobi格式的文件，可是最新版本把這些功能去掉了。
使用Gitbook寫你本身的Api文檔
Gitbook寫本身的書很方便，本人前段時間也發佈了一本免費書籍《Chef之道》。其實你用Gitbook不僅是能夠寫書，也能夠來寫Api文檔，我一直用Gitbook寫Api文檔，我總結了幾個優勢：
- Gitbook能夠免費建立私有庫，保密性比較高。
- 相似於Github，有版本控制。就是一個電子書版的Github。
- Gitbook Editor是一個很好用的Markdown編輯器，有不少貼心的快捷鍵讓你發掘，好比cmd+shift+d，若是你用習慣Atom、Sublime、Textmate之類的編輯器，會很喜歡這些特性。固然此類快捷鍵也不是不少，可是相信之後Editor功能會更加豐富，由於我剛纔說的這個特性應該也是新加的。起碼比Logdown這個Markdown編輯器好用多了。
- 一次編寫，多處使用。接下來咱們重點說這個，也就是我今天重點要說的。
一次編寫，多處使用。
如今是移動互聯網時代，不少App已經開發在維護，還有不少不少的App待開發，並且HTML五、js mvc框架的發展，有不少人都在維護Api接口。那麼寫一個可維護、可讀性高、帶版本控制、可爲所欲爲分發的接口文檔是多麼重要。
可讀性/ 可維護 / 版本控制
Gitbook是用Markdown寫的，還支持語法高亮等，用它寫出來的文檔，那看起來是至關愉悅的。
Gitbook正是天生帶版本控制，你能夠選擇任意一個你發佈過的版本。
可爲所欲爲分發
-
文檔寫好之後，你能夠把Gitbook源目錄下面的全部文件都複製到你項目下(app_root/docs/api/gitbook_api_dir)。這樣，你的項目就多了一份漂亮的文檔，開發人員還能夠在本地打開Web Preview生成在_book目錄下的靜態網頁愉悅的看你的Api接口文檔。 若是以爲複製太土了，你能夠直接把Gitbook Editor的Api文檔目錄建立在項目中。
-
後臺接口項目、Android App項目、iOS App項目均可以分發一份，你們可使用Gitbook Editor來協同管理接口。
-
上傳到Github，也能夠在線修改閱讀你的文檔，由於Github也支持Markdown。
是否是很是方便？
Update： 就在我寫完本文以後，我就發現gitbook增長了付費計劃， 免費的私有項目只容許建立一個。