公司的产品文档和手册目前是以 md 文件的形式放在官网项目里,这样每次更新,产品都会给一个新的 word 文件,然后开发的同学用工具转成 md 文件,放进项目里,重新部署。
这过于麻烦并且不合理了。所以就计划单独拉出来一个文档系统。要求有以下:
其中重点需求就是: 展示文档 、在线编辑、私有化部署 。
了解了一圈,发现展示文档的工具有很多,但是同时满足以上三个重点需求的就基本没有了,比如:Vuepress / Vitepress / Gitbook 这些都只支持 md 转成静态文件做展示,不支持在线编辑(Gitbook 的在线模式不能私有化)。Github 搜索关键词也没有找到有用的项目。所以来求助一下。
针对这个需求,V 友们有什么推荐的开源项目或者方案吗?
1
zacharyjia 2022-02-15 17:21:32 +08:00
|
2
ThirdFlame 2022-02-15 17:27:03 +08:00
codimd
|
3
devilte OP @zacharyjia 好窒息,想登录进去体验一下都登不进去,个人账号还不给登 -_-!
@ThirdFlame 看了一下,这个满足了在线编辑文档并且能够发布出去,这点很奈斯。 美中不足的是 1. 看官网上面没有搜索功能,不知道有没有相应的插件或者是别的解决方案,这个还要再研究一下; 2. markdown 编辑, 需求还是想要不增加用户的编写负担; |
4
zacharyjia 2022-02-16 09:28:49 +08:00
@devilte 本来就是团队应用,不让个人用倒是还算有理由。不过官方在账号系统上一直非常执着,不知道为啥。但是现在支持 gitea 登录了,自己部署还是可以的。
|
5
devilte OP @zacharyjia 好嘞 谢谢老哥~
|
6
fantasticit163 2022-03-31 20:57:29 +08:00
|