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增长了付费计划， 免费的私有项目只容许建立一个。