部门的文档一直用 wiki
记录,短暂的用过gitbook
,然后又改回了wiki
…… 想着换一款工具试试吧,这次选择了 docsify
,因为文档要放到公司内网,又想简单搞搞,于是把项目放到了公司内部的gitlab
上,使用jenkins
部署
docsify文档
- docsify官网: docsify官网 ,不过这是英文的
- docsify中文文档:docsify中文文档
用起来挺简单的,文档都是markdown
的,按照文档开发就可以
它还可以替换主题(虽然主题有点少,而且也不够好看……,有时间的话自己优化吧)
开发好了,要考虑怎么把它放到网上让大家都能看到,同时也要方便大家的编辑文档和修改,本来是想做在线markdown
编辑的,没有时间自己写Node
后台, 也不方便找java
后台同事写(还不如用Node
呢,至少后期维护方便),就暂时用了如下这个方案:
用gitlab
的在线编辑器编辑,保存提交后触发jenkins部署
就可以在网上看到编辑后的文档了
gitlab提交触发jenkins部署
这里默认gitlab
和jenkins
都搭建好了,是现成的环境,只要把gitlab
提交和jenkins
部署的两个动作连起来就可以了
gitlab
和jenkins
两边都需要配置一下,gitlab
需要生成token
和配置Webhooks
,jenkins
需要配置gitlab
的token
等等, 具体可以参考这篇文章:
然后就可以在线编辑并构建部署了
但是使用gitlab
在线编辑器去编辑文档实在是不舒服,有待赶紧优化