ShowDoc v2.9.14 发布， IT 团队的在线 API 文档、技术文档工具
star7th · 2021-12-09 10:16:48 +08:00 · 2785 次点击这是一个创建于 1071 天前的主题，其中的信息可能已经有所发展或是发生改变。
地址
开源地址： https://github.com/star7th/showdoc
官网： https://www.showdoc.com.cn/
更新内容：
- 可一键设置团队的成员项目权限为只读
- 选择目录时候可输入关键字搜索目录
- 在编辑页面时候可跳转去新建目录
- 完善页面排序功能
- 修复 xss 安全漏洞
- 解决 TOC 目录遮挡图标的问题
- 支持 runapi 客户端的接口状态功能
- 支持 runapi 客户端的全局 cookies 功能
- 支持 runapi 客户端的全局脚本功能
更新步骤请参考请参考手册的升级安装部分：
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
 |
1
BeijingBaby 2021-12-09 10:48:15 +08:00
功能可以，但是 UI 真的说不出来的感觉：丑！
|
 |
2
star7th OP @BeijingBaby 有推荐建议可以说一下，或者推荐个有偿设计师也行。
|
 |
3
Quarter 2021-12-09 11:08:37 +08:00 via iPhone
切换目录的时候，目录和页面会出现布局变化，导致页面抖动
|
|
4
star7th OP @Quarter 这个评估过了，大概还是能接受的。因为 showdoc 是每读取一个页面就远程加载渲染一下，并不是全部内容都预先加载完的，所以用户避免不了要晃一下。如果再多人反馈这个小问题，我就预先加个 loading 或者骨架屏之类的吧
|
 |
5
jabin88 2021-12-09 12:57:04 +08:00
可以加个教程，在群晖这种 nas 如何用 docker 来部署，类似于 gogs
|
 |
6
Kilerd 2021-12-09 13:18:27 +08:00
跟 swagger 的区别在哪里？ swagger 还能直接发请求测试，你这个还不行诶。
|
|
7
star7th OP @jabin88 showdoc 有 docker 教程 。https://www.showdoc.com.cn/help/65610 特殊情况使用 docker 的，自己根据实际情况变动即可。官方教程很难覆盖所有平台的
|
|
8
star7th OP @Kilerd showdoc 不直接支持接口测试，而是通过跟另一个客户端（类似 postman ）配合，你可以看一下 https://www.showdoc.com.cn/runapi/30291
|
|
10
star7th OP @jabin88 没理解你的意思。官方教程依照从简的思路，尽量照顾大部分人的需要。对于大部分的需求，已经给出标准教程。特殊平台的，自己只需要在标准教程上根据自己的实际情况变动即可。我很难覆盖全部平台，总不能群晖 nas/树莓派 /各种特殊硬件我都要专门买一份然后走通教程再写出来。
|
 |
11
raycloud 2021-12-09 14:27:18 +08:00
很早就用过，感觉比较简洁，个人觉得还不错，支持~
|
 |
12
Psily1017 2021-12-09 14:46:12 +08:00
用的很久了，支持！
|
 |
14
jxl594 2021-12-09 16:29:28 +08:00
个人觉得前几年的 UI 界面比现在好看多了，现在的看着很不协调
|
 |
16
sleet 2021-12-09 16:56:12 +08:00
我也感觉很丑，19 年我就用过当时我记得感觉还不错，可能是后来用别的多了
|
 |
17
Brian1900 2021-12-10 04:53:22 +08:00
19 年的时候用过一次，UI 还挺好的，使用体验也不错，不知道现在怎么样了
|
 |
18
superfatboy 2021-12-10 13:24:32 +08:00
还不错，就是 UI 个人感觉稍微差点
|
Select Language