在线文档管理系统

背景

现在部门里写的开发者文档,是用markdown写的,然后用vuepress部署起来,虽然有用webhhook做更新,但是文档的更新不方便,有些折磨。

有几个缺点:

1、编写文档的预览,跟实际站点显示的有差异。

2、更新内容需要像编写代码一样,不方便。

3、新增gitbook过于麻烦。

都2022年了,还做了用户体验那么差的东西。

需求

基于以上缺点,我很想要可在线编辑的文档站点。

几点需求:

1、可在线编辑,所见即所得。

2、有项目管理和文档管理。

3、页面风格符合产品要求。

至于文档编辑方式,就markdown就行,这样方便文档迁移。

开源项目

1、mindoc

这个除了页面风格不大符合,其他功能还是挺符合的。

功能如下:

  • 项目管理,可以对项目进行编辑更改,成员添加等。
  • 文档管理,添加和删除文档等。
  • 评论管理,可以管理文档评论和自己发布的评论。
  • 用户管理,添加和禁用用户,个人资料更改等。
  • 用户权限管理 , 实现用户角色的变更。
  • 项目加密,可以设置项目公开状态,私有项目需要通过Token访问。
  • 站点配置,可开启匿名访问、验证码等。

 

未完待续

posted @ 2022-02-17 22:51  海角在眼前  阅读(822)  评论(2编辑  收藏  举报