gitbook 编辑手册

前言

1. 目的：建立 CRM 自己的 FAQ 页面，减少重复回答反馈群中的问题，提升工程师效率。

2. 地址：http://172.30.13.197/crm/wiki/

什么是 gitbook ？

1. gitbook 是一个开源的文档系统，基于 git 和 markdown，非常方便的编辑和发布页面。 
2. gitbook 官网：https://github.com/GitbookIO/gitbook
3. markdown 百科：http://baike.baidu.com/item/markdown
4. gitbook 入门：https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md

使用 gitbook 编辑文档

1. 下载一个 gitbook 编辑器，地址为：https://www.gitbook.com/editor （根据自己的操作系统选择 windows、mac、linux 版本）。

2.  在本地 clone CRM 系统的 FAQ 文档 

   $ git clone  git@git.lianjia.com:fengxiao/crm-faq.git

3. 打开 GitBook Editor，点右下方的 Do This Later，暂不注册，然后打开 com-faq 文件夹。
4. 之后就可以进行实时编辑了，如下图
   
   1. 左上为目录结构，右键即可新建。下测为目录所列的实际 markdown 页面。
   2. 右侧有两栏，第一栏为编辑页面，第二栏为实时效果页面。
   
5. 编辑完之后，在文档文件夹下，将更改提交到 master 分支。

   $ git stash //隐藏本次更改
   $ git pull origin master
   $ git stash pop //显示本次更改
   $ git commit -am "digest for this commit"
   $ git push origin master

6. 服务器上更新静态文件，服务在 172.30.13.197 的 /home/work/local/crm-faq/, 在 com-faq 文件夹下更新文件，即完成文档更新。

   $ git pull origin master
   $ gitbook build

7. 现在访问 http://172.30.13.197/crm/wiki/, bingo!!! 更新成功了。