V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
star7th
V2EX  ›  分享创造

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

  •  1
     
  •   star7th · 216 天前 · 1757 次点击
    这是一个创建于 216 天前的主题,其中的信息可能已经有所发展或是发生改变。

    地址

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

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

    更新内容:

    1,优化安装向导

    2,优化代码块高亮 UI

    3,优化 posrtman/swagger 文件导入逻辑

    4,附件支持拖动上传

    5,图片和附件数据增加腾讯云储存的支持

    6,分享出去的单页支持全屏阅读模式

    7,升级一些前端依赖包

    8,完善全局搜索功能

    9,与 showdoc 搭配使用的 runapi 客户端 ( https://www.showdoc.com.cn/runapi ) 支持前后自定义脚本执行,可脚本控制环境变量和请求参数等

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

    showdoc 介绍

    ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具,既有开箱即用的在线托管服务版,也有免费的开源版( github 8800+ 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

    16 条回复    2021-05-07 09:23:08 +08:00
    LeslieLeung
        1
    LeslieLeung  
       216 天前 via iPhone
    关注一段时间了 支持一下
    0x49
        2
    0x49  
       216 天前
    一直在用,支持....
    Ansen
        3
    Ansen  
       216 天前
    用了好几年了,谢谢
    Ansen
        4
    Ansen  
       216 天前
    找机会试试让公司买授权
    star7th
        5
    star7th  
    OP
       216 天前
    @LeslieLeung
    @0x49

    感谢支持
    star7th
        6
    star7th  
    OP
       216 天前
    @Ansen 感谢支持。另外开源版是完全免费且不需要付授权费的哈。如果是使用官网托管服务则需要对资源使用进行按配付费。不过也很便宜的。
    funbox
        7
    funbox  
       216 天前
    666
    Ansen
        8
    Ansen  
       216 天前
    @star7th #6 那貌似没办法付费了,目前我们在内网,没有外网需求
    ihipop
        9
    ihipop  
       216 天前 via Android
    看了下官网没有 Linux 版本客户端。。。
    我猜是 cef 或者 electron 框架的客户端吧,包个 Linux 客户端应该不难。。。
    star7th
        10
    star7th  
    OP
       216 天前
    @ihipop 是 electron 框架的客户端。主要是用户呼声很少,所以就没打包。打包的话,linux 客户端就会额外占据多一个显示位置。我是那种不需要用到就省掉的想法,保持简洁。如果多一点用户反馈有必要就加上。
    Vvictor
        11
    Vvictor  
       216 天前
    支持一下,借楼问下作者文档的表格支持父子级的展示吗
    superliwei
        12
    superliwei  
       216 天前
    工具是好,但关键是文档难写啊
    star7th
        13
    star7th  
    OP
       215 天前
    @superliwei 如果你指的是写 markdown 麻烦,那么可以尝试配合 runapi 使用 https://www.showdoc.com.cn/runapi?page_id=30291 。这样就可以像用 postman 那样调试接口,然后调试完的时候顺便写完文档了。
    star7th
        14
    star7th  
    OP
       215 天前
    @Vvictor 不支持。讲实话这点我也想过,只是单凭 markdown 应该不好做。你有方案建议的话可以说下。
    liuzhaowei55
        15
    liuzhaowei55  
       215 天前
    @star7th 在 edge 浏览器中,同时打开垂直列表,固定垂直收藏夹,左侧边栏出现了文字遮挡,显示器为 24 寸 1080p 普通显示器。
    star7th
        16
    star7th  
    OP
       215 天前
    @liuzhaowei55 感觉 edge 的垂直标签是不是占据了网页本身的定位。如果是这样其实设计并不好。因为挺多网页导航都是左侧固定定位的。我有时间再看下怎么兼容。
    关于   ·   帮助文档   ·   API   ·   FAQ   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   2613 人在线   最高记录 5497   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 21ms · UTC 13:36 · PVG 21:36 · LAX 05:36 · JFK 08:36
    ♥ Do have faith in what you're doing.