从免费的Vuepress迁移到付费的语雀,我都经历了些啥?

193 阅读3分钟

大家好,我是爱折腾的刘大逵,写完这篇文章,我就开始着手设计CMS系统了!这篇文章主要会介绍我们开源的轻量级权限系统Eva为什么要从免费的Vuepress搬家至付费的语雀中。

当然,重中之重,先恭喜大家喜提国庆七天假!

接下来言归正传!

Vuepress的问题

我们来看看之前的Eva文档是什么样子的。如图

图片

看起来还真不错!文档结构也是非常的清晰:

图片

是不是看着挺眼熟?这种方式也是很多开源项目使用的方式,包括Vue官网也是采用这种方式。但它给我带来了问题!使用Vuepress,如果要更新文档,我是这样做的。

一、打开文档工程

Vuepress是一个代码工程,不能在线编辑,所以我得先用编辑器打开文档工程

二、修改并预览内容

接下来找到要修改的MD文件,做进一步修改。

三、发布

然后运行npm run docs:build打包,将打包后的文件上传到服务器来发布

但凡我在文档中发现了一个错别字,我都要执行上面三个步骤。这让我没了完善文档的欲望!但作为开源作者,想着用户们只能面对文档来开发,文档不完善肯定是不允许滴。所以,我决定想办法!

搬家到语雀

起初,我准备利用CI/CD来实现,当我push代码到仓库中时,给我自动发布一下。最后放弃,原因是:以上三个步骤,我只能省略最后一个步骤。并且,如果文档中需要加入图片,我还必须得放到工程里,还是太麻烦!

于是乎,我决定使用跟GoldPanKit文档中心一样的方式来维护Eva的文档。我现在写文档的步骤是这样的:

一、打开Eva文档

第一步当然要打开文档,这个文档我可以在代码工程中直接打开。

image.png

二、直接编辑

打开文档后,如果发现了不正确或需要完善的地方,我可以直接编辑更新。用户只需要刷新一下就生效了,是不是很方便?

图片

一个产品有三个点,分别是痛点、爽点、痒点,这是我18年在华润集团(就是你们国庆出去玩住的汉庭、全季以及你们在携程上订机票的集团)工作时听一位领导分享的内容,至今记忆犹新。语雀给我解决的痛点已经讲过了,带给我的爽点就是它还能支持非常丰富的文章元素,我最喜欢的便是思维导图,我用它完成了Eva多模块版本的工程设计:

图片

以及项目结构的说明

图片

这样来了解一个项目的整体,是不是就变得很舒服了?而且我也省心了不少。 

写在最后

感谢你阅读到这里,如果你喜欢我们的开源组织,喜欢我们的开源项目,或者喜欢我本人。请不要忘了,我们的项目完全开源免费,我们正在推广阶段,希望能多多关注,转发此文章来让更多的人知道我们,非常感谢!

我们的官方账号

金镐开源组织扫一扫.png