gitbook 编辑手册

前言

目的：建立 CRM 自己的 FAQ 页面，减少重复回答反馈群中的问题，提升工程师效率。
地址：http://172.30.13.197/crm/wiki/

什么是 gitbook ？

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

使用 gitbook 编辑文档

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

在本地 clone CRM 系统的 FAQ 文档

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

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

编辑完之后，在文档文件夹下，将更改提交到 master 分支。

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

服务器上更新静态文件，服务在 172.30.13.197 的 /home/work/local/crm-faq/, 在 com-faq 文件夹下更新文件，即完成文档更新。
```
1 $ git pull origin master
2 $ gitbook build
```
现在访问 http://172.30.13.197/crm/wiki/, bingo!!! 更新成功了。

转载于:https://www.cnblogs.com/seanvon/p/6479041.html

gitbook 编辑手册相关推荐

重磅：国家正式出台学术不端行为界定
来源:科研大匠大家都在反对学术不端,何为学术不端?如何界定学术不端行为?其实,此前并没有一个明确的标准. 2019年5月29日,国家新闻出版署才正式发布我国首个针对学术不端行为的行业标准--< ...
第一位女性商业程序员玛丽库姆斯去世，享年 93 岁！
作者 | 张洁出品 | 程序人生 (ID:coder _life) 据 The Register 报道,2 月 28 日,世界上首位使用商业应用编写计算机程序的女性.英国知名女程序员玛丽·库姆斯(M ...
ArcGIS_系列中文教程下载
ArcGIS_系列中文教程如链接有问题请在留言中说明ArcGIS9中文版系列丛书PDF(原书一 ...
计算机对应的自然科学,计算机类书稿加工应注意的几个问题
眭蔚摘要:本文对计算机类书稿的编辑加工特别需要注意的地方及易忽视的细节进行了论述,着重讨论了计算机类书稿的语言文字.图表.字符正斜体.程序格式.字符半全角.量和单位的编辑加工及书稿统一的问题. 关 ...
MarkDown常用技巧总结
针对的使用软件是:ReText,在Ubuntu 操作系统下 (第7次修改)2017-01-07 官方文档1(英文) 官方文档2(英文) 1.居中 <center> 我的内容</cen ...
web开发快速提高工作效率的一些资源
文:祈澈姑娘前端学习资源实在是又多又广,在这样的一个知识的海洋里,我们像一块海绵一样吸收,想要快速提高效率,平时的总结不可缺少,以下总结了一些,排版自我感觉良好,推送出来,后续持续跟新中...... ...
linux中的medium_如何在freeCodeCamp Medium出版物中发布
linux中的medium Update: Instead of publishing on Medium, we now run our own self-hosted open-source to ...
如何在Web浏览器中查看XML文件
一旦了解到HTML是XML的一种形式,您可能会想知道如果尝试在浏览器中查看XML文件会发生什么. 结果令人非常失望-Firefox在页面顶部显示一条横幅,上面写着:"此XML文件似乎没有与之 ...
第一位女性商业程序员玛丽库姆斯去世，享年 93 岁
作者 | 张洁据 The Register 报道,2 月 28 日,世界上首位使用商业应用编写计算机程序的女性.英国知名女程序员玛丽·库姆斯(Mary Coombs)去世,享年 93 岁. 图片来源 ...

gitbook 编辑手册

前言

什么是 gitbook ？

使用 gitbook 编辑文档

gitbook 编辑手册相关推荐

最新文章

热门文章