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

2021-12-09 10:16:48 +08:00
 star7th

地址

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

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

更新内容：

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

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

showdoc 介绍

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

2800 次点击
所在节点    分享创造
18 条回复
BeijingBaby
2021-12-09 10:48:15 +08:00
功能可以，但是 UI 真的说不出来的感觉：丑！
star7th
2021-12-09 10:55:06 +08:00
@BeijingBaby 有推荐建议可以说一下，或者推荐个有偿设计师也行。
Quarter
2021-12-09 11:08:37 +08:00
切换目录的时候，目录和页面会出现布局变化，导致页面抖动
star7th
2021-12-09 11:36:48 +08:00
@Quarter 这个评估过了，大概还是能接受的。因为 showdoc 是每读取一个页面就远程加载渲染一下，并不是全部内容都预先加载完的，所以用户避免不了要晃一下。如果再多人反馈这个小问题，我就预先加个 loading 或者骨架屏之类的吧
jabin88
2021-12-09 12:57:04 +08:00
可以加个教程，在群晖这种 nas 如何用 docker 来部署，类似于 gogs
Kilerd
2021-12-09 13:18:27 +08:00
跟 swagger 的区别在哪里？ swagger 还能直接发请求测试，你这个还不行诶。
star7th
2021-12-09 13:58:38 +08:00
@jabin88 showdoc 有 docker 教程 。https://www.showdoc.com.cn/help/65610 特殊情况使用 docker 的，自己根据实际情况变动即可。官方教程很难覆盖所有平台的
star7th
2021-12-09 13:59:53 +08:00
@Kilerd showdoc 不直接支持接口测试，而是通过跟另一个客户端（类似 postman ）配合，你可以看一下 https://www.showdoc.com.cn/runapi/30291
jabin88
2021-12-09 14:14:19 +08:00
@star7th 这就是爱用不用的态度？
star7th
2021-12-09 14:20:22 +08:00
@jabin88 没理解你的意思。官方教程依照从简的思路，尽量照顾大部分人的需要。对于大部分的需求，已经给出标准教程。特殊平台的，自己只需要在标准教程上根据自己的实际情况变动即可。我很难覆盖全部平台，总不能群晖 nas/树莓派 /各种特殊硬件我都要专门买一份然后走通教程再写出来。
raycloud
2021-12-09 14:27:18 +08:00
很早就用过，感觉比较简洁，个人觉得还不错，支持~
Psily1017
2021-12-09 14:46:12 +08:00
用的很久了，支持！
star7th
2021-12-09 15:46:32 +08:00
@raycloud
@Psily1017

谢谢支持哈，多帮忙向你们的技术朋友推广安利下 showdoc 呀。
jxl594
2021-12-09 16:29:28 +08:00
个人觉得前几年的 UI 界面比现在好看多了，现在的看着很不协调
star7th
2021-12-09 16:33:35 +08:00
@jxl594 几年前的 UI 真心不好看啊。现在好像老用户都已经挺接受新 UI 的
sleet
2021-12-09 16:56:12 +08:00
我也感觉很丑，19 年我就用过当时我记得感觉还不错，可能是后来用别的多了
Brian1900
2021-12-10 04:53:22 +08:00
19 年的时候用过一次，UI 还挺好的，使用体验也不错，不知道现在怎么样了
superfatboy
2021-12-10 13:24:32 +08:00
还不错，就是 UI 个人感觉稍微差点

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

https://www.v2ex.com/t/821047

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

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

© 2021 V2EX