ShowDoc 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
ShowDoc 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
授权协议 Apache
开发语言 PHP
操作系统 跨平台
软件类型 开源软件
所属分类 企业应用文档管理
开发厂商
地区 国产
提 交 者 xingchen
适用人群 未知
收录时间 2015-11-28

软件简介

ShowDoc是什么

每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!

程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的word文档放在哪个目录等各种非技术细节。

word文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。

ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (24)

加载中
什么时候解析body里面的对象参数呀
07/03 17:33
回复
举报
body 对象参数解析显示不出来,要是显示出来就完美了
06/24 14:58
回复
举报
越做越好拉,新增了很多实用的功能,比RAP好用多拉
04/15 17:38
回复
举报
很精简 但够用 666!
04/02 17:34
回复
举报
👍真的很棒,设计风格非常简约,但麻雀虽小五脏俱全,各类模版、团队管理做的都蛮好,非常适合中小型项目团队的日常协作。感谢~
2019/06/20 09:59
回复
举报

引用来自“风里的叶子”的评论

可以试下https://gitee.com/treeleaf/xDoc, 基于java注释生成在线和离线文档
就知道,投石问路,总有很多选择在评论区
2019/04/12 08:34
回复
举报
用go语言写了一个版本,供大家参考,不推荐实际应用 https://github.com/kphcdr/godoc
2018/11/21 01:27
回复
举报
可以试下https://gitee.com/treeleaf/xDoc, 基于java注释生成在线和离线文档
2018/08/05 13:30
回复
举报
swagger了解下
2018/07/25 18:20
回复
举报
打分: 力荐
好东西, 找了很久, 差点自己写了, 还好遇见你
2018/03/01 13:45
回复
举报
更多评论
发表于开发技能专区
10/26 10:16

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

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

0
10
发表于服务端专区
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的详细介绍,请看:htt...

12
12
发表于开发技能专区
07/03 10:15

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

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

3
17
发表于大前端专区
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.sho...

8
36
发表于大前端专区
06/08 10:09

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

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

8
13
发表于AI & 大数据专区
05/20 10:31

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

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

1
17
发表于软件架构专区
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 关于...

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

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

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

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

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

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

4
21
发表于软件架构专区
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...

30
16
发表于软件架构专区
01/04 11:12

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

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

0
16
发表于服务端专区
2019/12/24 09:20

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

更新内容: 此次更新主要更新了UI和完善交互。如对项目展示页面采用三栏式居中布局,对项目列表可视化面积增大,以及采用灰白等等。还有各种UI细节请更新后慢慢发现。 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.cc/help...

14
18
发表于软件架构专区
2019/11/18 10:21

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

更新内容: 1,允许自定义网站首页,可以在管理后台设置跳转到登录页或者指定的项目 2,搜索文档内容时候,支持关键字高亮 3,完善多语言翻译 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.cc/help...

3
17
发表于软件架构专区
2019/11/12 10:52

showdoc v2.4.16 更新,支持安卓和苹果app端编辑

showdoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具 ,详细介绍可见:https://www.showdoc.cc/help 本次更新推出手机客户端,支持在安卓和苹果手机上编辑文档。下载地址:https://www.showdoc.cc/app 如果你是使用官网在线版 showdoc,则下载 app 后直接使用即可。如果你是使用开源版 showdoc (在 github 搜...

5
26
发表于AI & 大数据专区
2019/08/20 10:00

ShowDoc 8月更新,IT 团队的在线 API 文档工具

更新内容: 1,增加从excel或者网页复制表格到showdoc的功能。编辑showdoc时,在“格式工具”处选择“粘贴插入表格”便可以看到功能提示。 2,新增管理员密码重置脚本命令。开源showdoc用户在忘记管理员密码的时候可以一键重置。具体使用方式见常见问题第一个https://www.showdoc.cc/help?page_id=16118 更新步骤请参考请...

0
18
发表于服务端专区
2019/04/17 08:59

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

ShowDoc v2.4.10 发布,IT 团队的在线 API 文档工具 更新内容: 1,项目列表页面支持拖动排序。同时废弃了之前的项目置顶功能 2,项目成员自行退出项目而不需要项目管理员操作 3,删除目录时会把其下的子目录和页面一并删除 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Sho...

3
27
发表于开发技能专区
2019/04/10 08:45

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

ShowDoc v2.4.8 发布,IT 团队的在线 API 文档工具 更新内容: 1,完善样式,对markdown的TOC标签将显示浮动标题目录 2,完善英文翻译和文档 3,完善附件上传功能 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732 关于Showdoc的详细介绍,请看:https://www.showdoc.cc/help...

0
27
发表于AI & 大数据专区
2018/12/03 09:12

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

更新内容: 1,修复了一个安全问题,此问题将导致文档数据被越权修改。请使用开源版showdoc的用户尽快升级到新版。 2,新增用户姓名字段并在团队成员中显示 3,优化表格宽度。当表格列数少于5时将均分页面,大于5时按字数设宽。 3,修复IE11下的js错误 更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/...

2
18
发表于服务端专区
2018/11/20 16:07

ShowDoc 发布 v2.4.1,支持 LDAP 认证登录

【showdoc v2.4.1 更新公告】 开源版showdoc增加了企业ldap登录的支持,可在管理后台配置。 开源版showdoc增加了是否允许公开注册的开关,可在管理后台配置。 对于showdoc原用户,如果要启用ldap的支持,则此次的升级步骤会比之前的常规升级方式繁琐一些。因为之前的环境和官方镜像都不包含ldap扩展。你需要根据下面教程...

2
12
发表于服务端专区
2018/11/03 15:04

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

更新内容: 为了加强多人多团队情形下的项目协作,showdoc正式推出团队管理功能。Team leader可以在项目列表页面找到团队管理按钮,然后添加团队。添加团队后,可以随时增加/删除团队成员、批量分配到不同项目里,并且可以设置不同项目里的成员权限。相比之前的简单成员管理模式,团队管理功能可以批量地进行人员的增删,...

1
30
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
2018/10/30 07:11

showdoc

现在在公司的文档中心是基于git+docsify来的。这种方式,就是对于程序员来说还好,因为让程序员写markdown文档还是比较方便的。 但是没有一个网站来写文档,对于很多人来说确实是不够方便的。在浏览腾讯云,开发者...

0
0
发表了博客
2019/08/17 10:33

ShowDoc速记

编写文档好工具showdoc部署 参考:https://www.showdoc.cc/ 一定要看,一定要用卷,丢失数据的痛苦,痛何如哉。 https://www.cnblogs.com/harrychinese/p/showdoc.html @@@code # 由于国内镜像与官网原镜像同步可能延迟,如果有网络条件,建议使用原镜像。如果网络不好,建议使用国内镜像 # 国内镜像安装命令 docker pul...

0
0
发表了博客
2019/02/19 16:56

部署showdoc

1、下载 https://github.com/star7th/showdoc 2、解压 sudo tar -zvxf ~/showdoc-2.4.5.tar.gz -C /home/wwwroot/default/ 3、赋权限 sudo chmod -R 777 server/ sudo chmod -R 777 install/ sudo chmod -R 777 Public/Uploads/ sudo chmod -R 777 Sqlite/ 4、安装 5、配置nginx server { listen 80; ...

0
0
发表了博客
2019/12/15 10:50

Docker搭建Showdoc

基础安装 安装前请确保你的环境已经装好了docker docker pull star7th/showdoc #新建存放showdoc数据的目录 mkdir /opt/showdoc mkdir /showdoc/html chmod -R 777 /showdoc #启动showdoc容器 docker run -d --name showdoc -p 4999:80 -v /showdoc/html:/var/www/html/ star7th/showdoc 根据以上命令操作的话,往后sho...

0
0
发表于云计算专区
2018/08/03 17:31

centos7:搭建ShowDoc

1、nginx yum install -y epel-release yum install -y nginx cp /etc/nginx/nginx.conf /etc/nginx/nginx.conf.bak #修改nginx配置文件 vim /etc/nginx/nginx.conf 38 server { 39 listen 80 default_server; 4......

0
0
发表了博客
2019/12/27 16:15

Docker安装showdoc

一、简介 ShowDoc是什么 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的word文档放在哪个目录等各种非技术细节。 word...

0
1
发表了博客
2018/11/17 13:39

nginx下部署showdoc

<h3>1. 安装nginx服务器<code>sudo apt-get install nginx -y</code> </h3> <h3>2. 启动服务<code>sudo service nginx start</code> </h3> <h3>3. 安装php环境</h3> sudo apt-get install -y php7.1 php7.1-fpm php7.1-gd php7.1-mcrypt php7.1-mbstring php7.1-mysql php7.1-pdo php7.1-sqlite <h3>4. 配置nginx</h3...

0
0
发表了博客
2019/10/11 15:31

ShowDoc 的安装与使用

安装ShowDoc 1、下载项目文件 git clone https://github.com/star7th/showdoc.git 2、配置域名,并发布 配置到项目根目录即可 3、安装 浏览器输入你配置的域名/install 选择语言,完成安装 4、常见问题 Linux系统下,由于文件权限的原因,选择原因,并点击安装之后会报错 此时需要对文件授权 这里,我直接切换了文件所属...

0
0
发表了博客
2018/03/24 23:48

docker 安装 showdoc

感谢博客 https://blog.csdn.net/zhangminemail/article/details/79107741 但是我搭建了一个虚拟机后,发现使用上面的博客的方法。却无法运行;发现了由于需要使用国外网站下载依赖,在国内下载失败造成的; 所以我用了国外的一个服务器,使用上面的方法。安装镜像成功所以我,把镜像进行保存下来,存到我的云盘中,我就...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
24 评论
397 收藏
分享
返回顶部
顶部