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

2021-04-12 09:45:46 +08:00
 star7th

地址

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

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

本版本更新内容:

1, 支持跨项目复制和移动目录以及目录下的文档

2, mock 功能前缀固定,后缀可以自定义 url 路径

3, 页面的历史版本可以编辑备注信息,方便自己备注版本差异

4, 关闭浏览器时候将自动解除锁定页面编辑的状态

5, 修复长项目标题引起的 bug

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

showdoc 介绍

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

3151 次点击
所在节点    分享创造
26 条回复
star7th
2021-04-12 17:06:49 +08:00
@xiaobanlong 如果是说用注释来生产文档的话,showdoc 有一套自己的语法可以自动从注释生成文档 https://www.showdoc.com.cn/page/741656402509783
mangosong
2021-04-12 18:37:00 +08:00
在用 支持一下
rekulas
2021-04-12 22:05:41 +08:00
发现一个 clue,首页针对用户和爬虫访问做了区分展示
star7th
2021-04-12 22:22:07 +08:00
@rekulas 主要是为了被搜索引擎收录。目前发现谷歌搜索索引得还好,百度一般般。
zibber
2021-04-13 12:01:51 +08:00
docker 升级都要迁移数据库,可以改的平滑一点
star7th
2021-04-13 15:49:28 +08:00
@zibber showdoc 的所有升级方式都是“先安装新版程序再迁移数据库”,这样能避免很多包袱问题,比如说要考虑到旧文件是不是修改过等兼容问题。如果采用我说的这种方式,完全不用考虑这种历史问题。对于想平滑操作的用户,我有提供一键操作脚本的。不使用一键脚本的用户可能就需要多执行一点命令了。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://yangjunhui.monster/t/769978

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX