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

有适合自建的文档系统推荐吗?

  •  1
     
  •   xiaoz · 2021-08-07 09:48:48 +08:00 · 5919 次点击
    这是一个创建于 1206 天前的主题,其中的信息可能已经有所发展或是发生改变。

    主要用来给自己的开源产品写文档用的,需求如下:

    • 支持 markdown
    • 支持私有部署
    • 支持后台管理
    • 免费

    1. 目前已知的有 MinDoc,但是作者好久都没更新了。
    2. bookstackapp 似乎还可以,但是不知道用来写文档怎么样,有用过的老哥给个地址看看么。
    第 1 条附言  ·  2021-08-08 17:10:59 +08:00

    感谢各位的推荐,目前觉得两款比较满意,showdoc和bookstackapp

    • showdoc部署简单,支持客户端,界面简洁,国内用户貌似比较多
    • bookstackapp界面美观,支持多语言,国内使用者貌似比较少,部署相对复杂

    最终选择了bookstackapp,已经上线:https://doc.xiaoz.me/

    19 条回复    2022-08-07 16:46:16 +08:00
    hotcool100
        1
    hotcool100  
       2021-08-07 10:06:01 +08:00   ❤️ 3
    vuepress
    vate32
        2
    vate32  
       2021-08-07 10:06:35 +08:00   ❤️ 2
    阮一峰昨天刚推荐的 https://www.showdoc.com.cn/
    ruixue
        3
    ruixue  
       2021-08-07 10:08:15 +08:00   ❤️ 1
    BookStack 挺不错的,可以一试。开发也比较活跃,使用也简单方便

    帮你找了个示例:

    https://wiki.mcxk.net
    cmdOptionKana
        4
    cmdOptionKana  
       2021-08-07 10:42:47 +08:00   ❤️ 1
    一般产品用 github 的 wiki 就够用了吧?
    liufish
        5
    liufish  
       2021-08-07 10:51:00 +08:00   ❤️ 1
    现在用 mkdocs,把一些成体系的东西放进去了
    xiaoz
        6
    xiaoz  
    OP
       2021-08-07 10:55:09 +08:00
    @cmdOptionKana #4 github 的 wiki 不能自己部署,不太符合需求。
    Felldeadbird
        7
    Felldeadbird  
       2021-08-07 11:00:48 +08:00   ❤️ 1
    要不试下我重构的 2.0 文档系统? 下周发布正式版 。https://gitee.com/fallBirds/PESCMS-DOC/tree/dev-2.0.0/

    效果可以看 https://document.pescms.com/ 。我最近在重写新全部系统文档。
    cmdOptionKana
        8
    cmdOptionKana  
       2021-08-07 11:14:41 +08:00   ❤️ 1
    啊,突然想起一个混 V 站的前端大佬做的产品

    V 站贴子 https://www.v2ex.com/t/698343
    官方示例 https://ts.xcatliu.com/
    wdssmq
        9
    wdssmq  
       2021-08-07 11:15:34 +08:00   ❤️ 1
    xiaoz
        10
    xiaoz  
    OP
       2021-08-07 11:40:29 +08:00
    @wdssmq #9,谢谢,这个以前用过,界面简洁,可惜没有后台管理,有点不方便。
    xiaoz
        11
    xiaoz  
    OP
       2021-08-07 11:41:15 +08:00
    @vate32 #2,这个貌似还不错,部署也简单。
    Rainshaw
        12
    Rainshaw  
       2021-08-07 11:41:54 +08:00   ❤️ 1
    https://js.wiki
    用着还行
    xiaoz
        13
    xiaoz  
    OP
       2021-08-07 12:13:22 +08:00
    @Rainshaw #12,老哥能给个你的演示地址吗?之前部署过 wiki.js ,感觉略微复杂。
    Rainshaw
        14
    Rainshaw  
       2021-08-07 16:40:28 +08:00
    @xiaoz #13 我是内网建的,目前 v2 部署挺简单的,甚至官网还给了 docker-compose.yml 直接就能用。
    w3cll
        15
    w3cll  
       2021-08-07 21:56:57 +08:00   ❤️ 1
    showdoc
    star7th
        16
    star7th  
       2021-08-07 23:45:22 +08:00   ❤️ 1
    推荐 showdoc,一开始简单好用,深入后使用,功能也强大得满足各种需求。https://www.showdoc.com.cn ,而且开源持续更新。
    FantasyPupil
        17
    FantasyPupil  
       2022-07-27 22:59:37 +08:00
    楼主现在用的什么文档管理呢?网站看着很舒服
    xiaoz
        18
    xiaoz  
    OP
       2022-07-27 23:07:44 +08:00 via Android
    FantasyPupil
        19
    FantasyPupil  
       2022-08-07 16:46:16 +08:00
    @xiaoz 谢谢,我瞅瞅
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1033 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 21ms · UTC 20:40 · PVG 04:40 · LAX 12:40 · JFK 15:40
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.