使用Typora+docsify+GitHub Pages搭建团队知识库

在实际工作中,搭建团队知识库是非常有必要的,比如:

  • 随着项目的迭代,有很多信息需要共享。需求、系统环境信息、任务分配情况、各端开发规范等。这些信息不能只留在某几个人的脑子里,如果有人离职,那这些就成了实实在在的坑。
  • 有些项目属于提供方,比如中间件,需要提供中间件使用指引;中台系统,需要提供接口文档给前端。

不少团队将文档整理成Word、Excel格式,需要的时候再发给人家。这样其实很不方便,一是传达不方便,总有遗漏的人没收到;二是更新不方便,你更新了文档别人可能还拿的旧文档开发。

所以在团队中,搭建一个在线的知识库是非常有必要的。

使用docsify

docsify是一个可简单快速生成一个小型的文档网站的工具。

其实市面上类似的工具很多,如:阿里的语雀、DokuWiki、MDwiki、HDwiki等。为什么选择docsify?

我认为其有如下优点:

  • 大部分文档不需要很复杂的样式,docsify使用Markdown格式,编辑方便。
  • 部署简单,不需要搭建后台服务、数据库等。docsify核心就是一个HTML,再实时渲染编辑的Markdown文件。
  • 可自定义菜单,并根据解析的Markdown文件结构自动生成目录。
  • 支持全文检索,这很有用。

所以有兴趣的可以跟随官网的指引搭建一个了解下,绝对不错~

官网地址:https://docsify.js.org/#/zh-cn/

使用Typora

Typora又是个什么东东?

上面写到使用Markdown写文档,那就需要一个比较好用的Markdown编辑器啊!没错,Typora就是个Markdown编辑器。

我们知道,Markdown其实是纯文本,通过特定字符来描述样式。很多编辑器呈现两栏,左边是源文件,右边是呈现的样式。Typora则更方便,直接在编辑区所见所得。而且还有各式各样的主题可选择。

反正就是一个很好用的Markdown编辑器啦!

官网地址:https://www.typora.io/

使用GitHub Pages

很愉快的使用Typora编辑好文档后,当然是要部署了。

由于docsify就是个静态站点,随便找个服务器丢上去就可以了,比如:Apache、NGINX。

但是也有个问题:文档肯定是多人写的,我们一般会保存在SVN/Git上,那每次改完后我们都要更新最新文档,打包上传到服务器,这稍显麻烦!

使用GitHub Pages就可以减少中间上传那一步。它像一个静态空间,空间呈现的内容就是你提交到Github上的代码,由于docsify的文件都是静态的,不需要编译,所以提交代码后网站内容就直接呈现出来了。

官网地址:https://pages.github.com/

国内也有类似的服务:码云 Pages

总结

随着行业的发展,各种好用的工具层出不穷。我们作为行业人员,更应该善于利用这些工具提升自身工作的效率和质量。

最后,感谢这些作者的贡献。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,922评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,591评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,546评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,467评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,553评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,580评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,588评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,334评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,780评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,092评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,270评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,925评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,573评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,194评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,437评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,154评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,127评论 2 352

推荐阅读更多精彩内容

  • # Python 资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列...
    小迈克阅读 2,978评论 1 3
  • 前言 一直就想搭建一个属于自己的博客网站,但是一直拖着没有执行,在一次偶然的机会看到了鸿洋大神的 如何利用gith...
    Xuelong_li阅读 1,102评论 3 0
  • 对于喜欢折腾个人博客的人来说,一个可玩性强的博客/博客平台才是最适合自己的。可玩性包括自定义主题/功能,现有的通用...
    LeapDeXign阅读 337评论 0 1
  • 2017年8月15日如是家人温玲,种种子第15天 发心:我今不是为了我个人而闻思修,而是为了六道轮回一切如母有情众...
    温馨霏玲阅读 102评论 0 1
  • 万物凋零,落叶归根,全在秋风乍起这一念之间。
    酒分阅读 171评论 0 1