達爾文曾經說過：「任何一個項目都應該有一個 readme」。
恩，<code>readme.md</code> 對于任何一個項目來說都是不可或缺的一部分，無論是對于使用者還是後續維護者都是灰常重要哒:p
對于小型項目，一個 <code>readme.md</code> 足以，但是如果是一個大項目的話（如 midway），那就不是一個 <code>readme.md</code> 可以搞定的啦。本文就來扯一下使用 gitbook 為你的項目寫一本**書**。
在你的文檔目錄下建立檔案 <code>summary.md</code>，這個檔案就是這本書的目錄啦：
<code>summary.md</code> 的格式規範如下：
然後執行 <code>gitbook init</code> 初始化，gitbook 會根據 <code>summary</code> 的結構生成對應的目錄檔案：
在對應的文檔目錄下運作 <code>gitbook serve</code> 會啟動一個本地的靜态伺服器：
通路 <code>http://localhost:4000/</code> 就可以實時的預覽啦，并且支援 <code>livereload</code>, 灰常贊~接下來結合預覽的功能編輯對應的文檔，完成之後就可以釋出啦。
在文檔目錄下執行 <code>gitbook build</code> 會生成一個 <code>_book</code> 的目錄，這個目錄就是我們的靜态網站啦，然後通過 demo 平台或者 github pages 就可以很簡單的完成部署了。
因為 uitest 的 <code>docs</code> 本身就是在 <code>express</code> 應用中的，是以我隻需要在 express 中增加一個靜态伺服器即可：
然後通路 http://uitest.taobao.net/docs/index.html 即可。
上面說的都是做項目文檔，但是如果你想寫本書，那麼 gitbook 提供了更為友善的服務，請移步 gitbook 官方網站
正文完。
文章轉載自：http://sobear.me/
作者：大果