ShowDoc 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
ShowDoc 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
ShowDoc 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !

软件简介

ShowDoc 是一个非常适合 IT 团队的在线文档分享工具,它可以加快团队之间沟通的效率。通过 showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。

目前超过100000+的互联网团队正在使用showdoc,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。

它可以用来做什么

  • API文档( 查看Demo

    随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。

  • 数据字典( 查看Demo

    一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。

  • 说明文档(查看Demo )

    你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。

它都有些什么功能

  • 分享与导出

    • 响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。
  • 权限管理

    • 公开项目与私密项目

      ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。

    • 项目转让

      项目创建者可以自由地把项目转让给网站的其他用户。

    • 项目成员

      你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)

  • 编辑功能

    • markdown编辑

      ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown,请在搜索引擎搜索”认识与入门 Markdown”

    • 模板插入

      在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。

    • 历史版本

      ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论

点击加入讨论🔥(26)
发表了资讯
2022/03/24 13:11

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

更新内容: 可以快速复制网页文章到showdoc,会自动转成markdown格式 更改代码块样式 代码块增加快速复制功能 修复文件上传漏洞 修复编辑器一些特殊字符转义的bug 增加从SQL转成markdown表格的格式工具 退出OAuth2登录时候允许设置回调 如何操作 更新步骤请参考请参考手册的升级安装部分: https://www.showdoc.com.cn/help?page_id=13732 介绍 ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具,既有开箱即用的在...

0
10
发表了资讯
2022/01/10 09:41

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

更新内容: 1 ,安全更新 2 ,增加页面修改提醒功能,可通知指定的项目成员 3 ,增加项目变更记录功能(查看入口在项目主页的右侧工具栏的更多展开按钮中) 4 ,可以导入文件(postman/swagger/markdown 压缩包)到已存在的项目内,也可以重复导入以覆盖更新 5 ,优化注释生成文档功能 6 ,支持通过 s3 协议上传附件 更之前的一些版本更新汇总 1 ,修复导入 swagger 文件的问题 2 ,修复点击文件库错误的问题 3 ,支持 runapi 客户...

2
13
发表了资讯
2021/12/09 10:04

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

更新内容: 可一键设置团队的成员项目权限为只读 选择目录时候可输入关键字搜索目录 在编辑页面时候可跳转去新建目录 完善页面排序功能 修复xss安全漏洞 解决TOC目录遮挡图标的问题 支持runapi客户端的接口状态功能 支持runapi客户端的全局cookies功能 支持runapi客户端的全局脚本功能 更新步骤请参考请参考手册的升级安装部分: https://www.showdoc.com.cn/help?page_id=13732 showdoc介绍 ShowDoc是一个非常适合IT团队的在线...

0
10
发表了资讯
2021/08/24 11:56

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

更新内容: 1,修复若干个安全漏洞。 2,升级flowchart.js版本,支持绘制更多图表 3,用户修改密码后,其他设备的登录token会失效 4,全局搜索的时候可以搜索项目名字和文档内容 5,修复编辑器若干bug 6,表格项目的锁定逻辑修复 更新步骤请参考请参考手册的升级安装部分: https://www.showdoc.com.cn/help?page_id=13732 showdoc介绍 ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具,既有开箱即用的在线托管服务版,...

0
10
发表了资讯
2021/05/25 09:17

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

更新内容: 1,引入项目分组功能,以解决项目数比较多的场景 2,增加OAuth2.0登录和通用接入登录 3,管理后台可以配置保存的页面历史版本梳理 4,手机客户端完善UI以及修复一些bug 9,与showdoc搭配使用的runapi客户端 (https://www.showdoc.com.cn/runapi) 支持参数描述多层级生成。 更新步骤请参考请参考手册的升级安装部分: https://www.showdoc.com.cn/help?page_id=13732 showdoc介绍 ShowDoc是一个非常适合IT团队的在线...

0
13
发表了资讯
2021/05/06 10:59

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

更新内容: 1,优化安装向导 2,优化代码块高亮UI 3,优化posrtman/swagger文件导入逻辑 4,附件支持拖动上传 5,图片和附件数据增加腾讯云储存的支持 6,分享出去的单页支持全屏阅读模式 7,升级一些前端依赖包 8,完善全局搜索功能 9,与showdoc搭配使用的runapi客户端 (https://www.showdoc.com.cn/runapi) 支持前后自定义脚本执行,可脚本控制环境变量和请求参数等。 更新步骤请参考请参考手册的升级安装部分: https://...

0
13
发表了资讯
2021/04/12 09:38

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

更新内容: 1, 支持跨项目复制和移动目录以及目录下的文档 2, mock功能前缀固定,后缀可以自定义url路径 3, 页面的历史版本可以编辑备注信息,方便自己备注版本差异 4, 关闭浏览器时候将自动解除锁定页面编辑的状态 5, 修复长项目标题引起的bug 更新步骤请参考请参考手册的升级安装部分: https://www.showdoc.com.cn/help?page_id=13732 showdoc介绍 ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具,既有开箱即用的在...

4
13
发表于开发技能专区
2021/01/13 13:37

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

更新内容: 更新首页 UI 兼容 php8 运行环境 官方 docker 镜像更换基础构建镜像,修复了一些安全问题 修复导入文件的 bug 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.com.cn/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.com.cn/help

1
8
发表于开发技能专区
2020/11/23 13:08

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

更新内容: showdoc增加mock数据功能 showdoc的辅助工具runapi客户端增加mock数据功能 showdoc的辅助工具runapi客户端增加全局参数和环境功能 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.com.cn/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.com.cn/help...

0
13
发表于开发技能专区
2020/10/26 10:16

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

更新内容: 1, 新增对swagger3(openapi3)的格式导入支持 2, 导出的时候可以选择只导出一个单页 3, runapi增加项目导出功能 4, 游客用户也可以看到公开页面的修改历史 5, 修复表格项目不支持一些特殊符号的问题 6, 修复项目左侧菜单栏初始打开时候默认展开的问题 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.com.cn/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.com.cn/help...

0
10
发表于大前端专区
2020/07/08 19:44

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

更新内容: 新增对电子表格的支持,用户创建项目的时候可以选择表格项目。 功能包括但不限于: 1,导入导出Excel表格 2,合并单元格/居中/对齐等 3,数据列筛选 4,求和/平均值等函数支持 5,等等 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.cc/help...

12
11
发表于大前端专区
2020/07/03 10:15

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

更新内容: 1,支持思维导图。在编辑器能找到插入思维导图的按钮,根据系统示例便可知道用法。 2,开源版showdoc更新程序后将自动升级数据库,不再像之前那样需要开发者手动执行升级数据库脚本。 3,管理员在后台可以编辑用户姓名 4,其他小细节更新 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.cc/help...

3
17
发表于软件架构专区
2020/06/24 09:49

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

本次更新: 1,推出调试接口的客户端(类似postman),支持windows和mac平台。开发者在调试接口的同时即可自动生成文档到showdoc,简单好用易上手。 详情请看:https://www.showdoc.cc/runapi 2,修复MAC客户端不能复制粘贴的问题。 3,修复页面编辑锁定的bug 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.cc/help...

8
36
发表于开发技能专区
2020/06/08 10:09

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

更新内容: 1、推出Mac客户端,下载链接:https://www.showdoc.cc/clients 2、可以给成员只授权项目的某个目录,适合更精细化的权限控制。 3、当用户编辑页面的时候将自动锁定,防止其他人修改覆盖 4、当markdown的超链接指向本项目的时候,将在当前项目展开(之前是新窗口打开) 5、优化前端代码,拥抱eslint代码规范 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Showdoc的详细介...

8
13
发表于软件架构专区
2020/05/20 10:31

ShowDoc v2.7.0 发布,IT 团队的在线 API 文档工具

本版本主要更新: 可在管理后台设置图片和附件上传到阿里云或七牛云 修复了一个上传文件的安全漏洞 编辑器增加三个按钮,对应的功能分别是插入标题目录TOC、插入视频和图文居中 让编辑器的预览效果和实际样式保持一致,同时优化markdown渲染样式 新增批量分配项目到团队功能 新增团队转让功能 本版本同时包含的次要更新: 修复了一个单页分享地址的bug 分享的网页标题改为页面标题 访问密码页面对回车键支持 编辑器初始化时保持...

1
17
发表于软件架构专区
2020/04/02 11:23

ShowDoc v2.6.7 发布,IT 团队的在线 API 文档工具

更新内容: 1,支持无限层级目录 2,修复一个上传木马文件的安全漏洞 3,修复sh脚本自动生成api文档和数据字典时候不支持“&”符号的bug 4,新用户注册系统将自动生成示例项目(此功能之前只存在官网在线版,现在更新到开源版) 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.cc/help...

2
15
发表于软件架构专区
2020/03/24 10:22

ShowDoc v2.6.5 发布,IT 团队的在线 API 文档工具

更新内容: 支持导出markdown压缩包。导出的压缩包可以在showdoc中重新导入。导入方式是新建项目-文件导入。此功能可用于离线备份压缩包以及在不同showdoc之间迁移数据。 支持导入postman。导入方式是新建项目-文件导入 支持导入swagger 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.cc/help...

5
22
发表于开发技能专区
2020/02/19 15:53

ShowDoc v2.6.2 发布,IT 团队的在线 API 文档工具

更新内容: 1、推出windows版本客户端,支持网页端所有功能。客户端地址:https://www.showdoc.cc/clients 2、优化手机app连接服务器的问题 3,延长用户自动登录有效期 4,修复一些影响用户体验的弹窗小bug 客户端截图:

4
21
发表于AI & 大数据专区
2020/02/11 14:21

ShowDoc v2.6.1 发布,IT 团队的在线 API 文档工具

更新内容: showdoc正式支持plantuml,包括时序图、用例图、类图、组件图、状态图等等。你可以使用markdown代码块声明plantuml,然后中间插入plantuml语句。详情请看文档https://www.showdoc.cc/p/69d2f7ad6306f13363bb803e755068c7 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.cc/help...

30
16
发表于AI & 大数据专区
2020/01/04 11:12

ShowDoc v2.5.5 发布,IT 团队的在线 API 文档工具

更新内容: 1,管理目录的时候可以通过拖动的方式对目录进行排序和转移 2,编辑页面的时候可以通过拖动的方式对页面进行排序 3,优化项目列表页的项目拖动排序效果 4,优化小屏幕笔记本下的显示效果 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.cc/help...

0
16
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
暂无内容
26 评论
447 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部