V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
devilte
V2EX  ›  问与答

有什么推荐的可支持在线编辑的文档系统呢?

  •  
  •   devilte · 2022-02-15 14:10:51 +08:00 · 1451 次点击
    这是一个创建于 794 天前的主题,其中的信息可能已经有所发展或是发生改变。

    公司的产品文档和手册目前是以 md 文件的形式放在官网项目里,这样每次更新,产品都会给一个新的 word 文件,然后开发的同学用工具转成 md 文件,放进项目里,重新部署。

    这过于麻烦并且不合理了。所以就计划单独拉出来一个文档系统。要求有以下:

    • 展示文档
    • 支持在线编辑文档,不用每次更新文档都要部署一次
    • 文档编辑支持快捷语法,就像 notion 、语雀、wolai 等笔记那样,输入一个'/'或者组合键 快速选择语法模板 (考虑到不是人人都会 md 语法,这种方式更容易被接受)
    • 私有化部署,部署在我们自己的服务器上
    • 最好前端能完成,不需要后端支持

    其中重点需求就是: 展示文档在线编辑私有化部署

    了解了一圈,发现展示文档的工具有很多,但是同时满足以上三个重点需求的就基本没有了,比如:Vuepress / Vitepress / Gitbook 这些都只支持 md 转成静态文件做展示,不支持在线编辑(Gitbook 的在线模式不能私有化)。Github 搜索关键词也没有找到有用的项目。所以来求助一下。

    针对这个需求,V 友们有什么推荐的开源项目或者方案吗?

    6 条回复    2022-03-31 20:57:29 +08:00
    zacharyjia
        1
    zacharyjia  
       2022-02-15 17:21:32 +08:00
    ThirdFlame
        2
    ThirdFlame  
       2022-02-15 17:27:03 +08:00
    codimd
    devilte
        3
    devilte  
    OP
       2022-02-15 20:56:53 +08:00
    @zacharyjia 好窒息,想登录进去体验一下都登不进去,个人账号还不给登 -_-!


    @ThirdFlame 看了一下,这个满足了在线编辑文档并且能够发布出去,这点很奈斯。 美中不足的是
    1. 看官网上面没有搜索功能,不知道有没有相应的插件或者是别的解决方案,这个还要再研究一下;
    2. markdown 编辑, 需求还是想要不增加用户的编写负担;
    zacharyjia
        4
    zacharyjia  
       2022-02-16 09:28:49 +08:00
    @devilte 本来就是团队应用,不让个人用倒是还算有理由。不过官方在账号系统上一直非常执着,不知道为啥。但是现在支持 gitea 登录了,自己部署还是可以的。
    devilte
        5
    devilte  
    OP
       2022-02-16 10:01:44 +08:00
    @zacharyjia 好嘞 谢谢老哥~
    fantasticit163
        6
    fantasticit163  
       2022-03-31 20:57:29 +08:00
    https://github.com/fantasticit/think

    我在搞这个,期中的核心技术都是利用开源代码,可以看下,也可以用相应的开源技术自己开发一个。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   2635 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 28ms · UTC 01:54 · PVG 09:54 · LAX 18:54 · JFK 21:54
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.