达尔文曾经说过：「任何一个项目都应该有一个 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/
作者：大果