使用 GitBook 寫文檔

都放在 GitBook 上提供給人們閱讀，剛好 Wide 也需要寫文檔，索性就嘗試使用 GitBook 來做。

GitBook 簡介

GitBook 是一個通過 Git 和 Markdown 來撰寫書籍的工具，最終可以生成 3 種格式：

• 靜態站點：包含了交互功能（例如搜索、書簽）的站點
• PDF：PDF 格式的文件
• eBook：ePub 格式的電子書文件
</ul>

GitBook 是免費且開源的，項目地址：https://github.com/GitbookIO/gitbook

Git 方式

GitBook 使用 Git 進行寫作內容管理。

• 從用戶的角度看，這樣能夠方便地進行多人協作（連程序源代碼都能管好，書籍自然不在話下），還不用學習額外概念或用法
• 從設計實現的角度看，這樣能夠合理利用已有工具（不重復造輪）滿足產品需求，甚至擴展性更好（Git 相關服務能夠利用的太多了）
</ul>

正所謂：“人發地，地法天，天法道，道法自然”啊。

Markdown

GitBook 不只是利用了 Git，目前非常流行的 Markdown 也被運用其中。

使用 Markdown 最大的好處就是簡單：

• 語法簡單，并且能夠形象地表達出意圖（例如無序列表使用 * ，強調使用 ** ，一個 # 表示 H1、兩個 # 表示 H2）
• 不干擾寫作者：語法標記在視覺上對寫作者的負面影響不大（不像 HTML 滿屏的 <>）
</ul>

總之，Markdown 就是能夠讓寫作者更專注于內容創作。

不過 GitBook 不只是簡單地使用 Markdown，使用 Markdown 編寫的內容只是源格式，最終的目標格式可以為 PDF、ePub 等。

靜態站點

在本地編寫完內容后我們需要將內容提交到 GitBook 上進行書籍的構建。GitBook 會將書籍構建為 4 種格式（JSON、ePub、PDF、Website）。 其中我們最常用的應該是靜態站點，這樣能夠方便傳播。

客戶端編輯器

可以使用 GitBook 的官方編輯器來進行寫作、發布等管理，非常方便：



其他

GitBook 還有很多功能，例如：

• 自定義靜態站點域名
• 多語言支持
• 書籍私有
• 自定義封面（弄個漂亮的書皮吧）
• 交互式練習、提問（這個用于寫問答類書籍或習題類書籍會很有用）
</ul>

題外話

GitHub、GitBook、GitXXX 都很流行啊，為什么呢？

Git 已經不只是一個版本控制系統了，它的分布式協作方式正在潛移默化地影響著很多程序的設計，最終影響了很多在線服務的提供方式。這樣一種私有-公有可控的網絡信息架構是非常值得我們學習并實踐的，這樣架構的各類產品將越來越多。



來自：http://88250.b3log.org/write-doc-via-gitbook