JavaScript is required

docsify建站,gitlab提交触发jenkins部署

部门的文档一直用 wiki 记录,短暂的用过gitbook,然后又改回了wiki…… 想着换一款工具试试吧,这次选择了 docsify ,因为文档要放到公司内网,又想简单搞搞,于是把项目放到了公司内部的gitlab上,使用jenkins部署

docsify文档

  1. docsify官网: docsify官网 ,不过这是英文的

docsify官网
docsify官网

  1. docsify中文文档:docsify中文文档

docsify中文文档
docsify中文文档

用起来挺简单的,文档都是markdown的,按照文档开发就可以

它还可以替换主题(虽然主题有点少,而且也不够好看……,有时间的话自己优化吧)

开发好了,要考虑怎么把它放到网上让大家都能看到,同时也要方便大家的编辑文档和修改,本来是想做在线markdown编辑的,没有时间自己写Node后台, 也不方便找java后台同事写(还不如用Node呢,至少后期维护方便),就暂时用了如下这个方案:

gitlab的在线编辑器编辑,保存提交后触发jenkins部署

就可以在网上看到编辑后的文档了

gitlab提交触发jenkins部署

这里默认gitlabjenkins都搭建好了,是现成的环境,只要把gitlab提交和jenkins部署的两个动作连起来就可以了

gitlabjenkins两边都需要配置一下,gitlab需要生成token和配置Webhooksjenkins需要配置gitlabtoken等等, 具体可以参考这篇文章:

Jenkins配置Gitlab自动触发构建

然后就可以在线编辑并构建部署了

但是使用gitlab在线编辑器去编辑文档实在是不舒服,有待赶紧优化