V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
爱意满满的作品展示区。
star7th

ShowDoc v3.6.0 发布, IT 团队的在线 API 文档、技术文档工具

  •  
  •   star7th · Nov 12, 2025 · 1436 views
    This topic created in 169 days ago, the information mentioned may be changed or developed.

    地址

    开源地址: https://github.com/star7th/showdoc

    官网: https://www.showdoc.com.cn/

    更新内容:

    • 完善开放 api ,支持页面和目录的新增修改删除接口,以实现更多自动化能力
    • 支持 Mermaid 绘图
    • 可将项目导出成离线 html
    • 项目管理员可配置项目是否开启评论和质量反馈
    • 超级管理员可在管理后台配置登录态超时时间和注册密码强度
    • 超级管理员可在管理后台查找并清理未使用附件

    如何操作

    更新步骤请参考请参考手册的升级安装部分: https://www.showdoc.com.cn/help?page_id=13732

    介绍

    ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具,既有开箱即用的在线托管服务版,也有免费的开源版( github 1 万+ star )。通过 showdoc ,你可以方便地使用 markdown 语法来书写出美观的 API 文档、数据字典文档、技术文档、在线 excel 文档等等。如果不想编辑 markdown 文档,你还可以利用 showdoc 的自动化能力,从程序注释中自动生成 API 文档,或者从搭配的 RunApi 客户端(类似 postman 的 api 调试工具)中一边调试接口、一边自动生成文档。无需手动编写文档,释放生产力。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc 还支持多平台客户端,有 win 客户端、mac 客户端、ios 、android 等,更方便跨平台使用。目前超过 100000+的互联网团队正在使用 showdoc ,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。

    关于 Showdoc 的详细介绍,请看: https://www.showdoc.com.cn/help

    stebest
        1
    stebest  
       Nov 12, 2025
    前几年用过,挺不错的,给个赞
    DavZhn
        2
    DavZhn  
       Nov 14, 2025
    5 年前用过,挺不错的,给个赞
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   886 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 44ms · UTC 19:28 · PVG 03:28 · LAX 12:28 · JFK 15:28
    ♥ Do have faith in what you're doing.