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

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

  •  
  •   star7th · 2021-08-24 11:58:51 +08:00 · 1852 次点击
    这是一个创建于 948 天前的主题,其中的信息可能已经有所发展或是发生改变。

    地址

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

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

    更新内容:

    1,修复若干个安全漏洞。

    2,升级 flowchart.js 版本,支持绘制更多图表

    3,用户修改密码后,其他设备的登录 token 会失效

    4,全局搜索的时候可以搜索项目名字和文档内容

    5,修复编辑器若干 bug

    6,表格项目的锁定逻辑修复

    更新步骤请参考请参考手册的升级安装部分:

    https://www.showdoc.com.cn/help?page_id=13732

    showdoc 介绍

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

    8 条回复    2021-09-16 13:49:01 +08:00
    inroading
        1
    inroading  
       2021-08-24 12:19:33 +08:00
    后台为了兼容用的 ThinkPHP3.2.3,那前台兼容 IE6 吗,建议升级一下后台框架
    star7th
        2
    star7th  
    OP
       2021-08-24 13:05:01 +08:00
    @inroading 不一样的概念。IE6 在 IT 群体里使用率非常低。而后端的兼容性,老系统的使用率太高了。举个例子,现在国内主流的 linux 系统之 centos7,其默认的 php 版本是 5.4 。这块用户还是不能直接放弃。
    liuzhihang
        3
    liuzhihang  
       2021-08-24 14:04:16 +08:00
    API 接口不影响吧。 我的插件 Doc View 不知道还能不能用
    star7th
        4
    star7th  
    OP
       2021-08-24 14:07:02 +08:00
    @liuzhihang 你是通过开放 api 还是模拟登录写入数据?大部分情况都不会改接口。但不排除可能会有字段变更的情况。一版开放 api 会考虑向后兼容性,因为可能已经有程序调用了开放 api
    liuzhihang
        5
    liuzhihang  
       2021-08-24 14:21:25 +08:00
    @star7th 收到
    geniusmyn
        6
    geniusmyn  
       2021-09-15 15:50:45 +08:00
    最近 showdoc 为什么打不开了呢
    star7th
        7
    star7th  
    OP
       2021-09-15 18:46:54 +08:00
    @geniusmyn 没有打不开啊
    geniusmyn
        8
    geniusmyn  
       2021-09-16 13:49:01 +08:00
    @star7th 今天好了,昨天前天不知道为什么打不开官网
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   5345 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 27ms · UTC 08:08 · PVG 16:08 · LAX 01:08 · JFK 04:08
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.