公司的产品文档和手册目前是以 md 文件的形式放在官网项目里,这样每次更新,产品都会给一个新的 word 文件,然后开发的同学用工具转成 md 文件,放进项目里,重新部署。
这过于麻烦并且不合理了。所以就计划单独拉出来一个文档系统。要求有以下:
- 展示文档
- 支持在线编辑文档,不用每次更新文档都要部署一次
- 文档编辑支持快捷语法,就像 notion 、语雀、wolai 等笔记那样,输入一个'/'或者组合键 快速选择语法模板 (考虑到不是人人都会 md 语法,这种方式更容易被接受)
- 私有化部署,部署在我们自己的服务器上
- 最好前端能完成,不需要后端支持
其中重点需求就是: 展示文档 、在线编辑、私有化部署 。
了解了一圈,发现展示文档的工具有很多,但是同时满足以上三个重点需求的就基本没有了,比如:Vuepress / Vitepress / Gitbook 这些都只支持 md 转成静态文件做展示,不支持在线编辑(Gitbook 的在线模式不能私有化)。Github 搜索关键词也没有找到有用的项目。所以来求助一下。
针对这个需求,V 友们有什么推荐的开源项目或者方案吗?