ShowDoc(API文档编辑工具)v2.4.0官方版

ShowDoc是一款非常强大的文档编辑软件，本作主要的用处就是为团队提供更加方便的交流工具。还可以非常方便快速地编写出美观的 API 文档。需要的快点下载试试吧。

ShowDoc是什么

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

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

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

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

ShowDoc可以做什么

API文档（ 查看Demo）

随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档，同时还将支持从代码文件中自动生成API文档

数据字典（ 查看Demo）

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

说明文档（查看Demo ）

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

ShowDoc功能：

分享与导出

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

权限管理

公开项目与私密项目

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

项目转让

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

项目成员

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

团队管理

你可以自行添加多个团队，为团队分配不同的项目，同时设置团队里每个人的权限。

编辑功能

markdown编辑

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

模板插入

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

历史版本

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

ShowDoc亮点：

1：支持markdown语法（所有的api接口写作现在都支持这个吧，因为他现在太方便了）

2：支持多用户协作，你可以在项目下面随意添加多个用户一起完成api文档的写作。

3：可以分享并导出项目，生成需要的文档格式如doc，可以离线浏览

4：支持响应式，手机电脑同样精彩

5：支持项目转让

6：支持模版插入

7：支持历史版本，你可以把操作恢复到以前的版本。

8：showdoc完全开源

9：可以部署到自己的服务器

10：如果在线使用，可以设置自己的个性域名，也可以对文档进行加密，浏览者需要密码才能访问

11：可以通过一个在线测试api的工具，直接生成markdown，你几乎不用写代码就能过所有的参数自动生成

ShowDoc常见问题：

忘记了密码怎么办?

如果是使用在线ShowDoc，忘记密码的话可联系xing7th@gmail.com，邮件中说明你的用户名和旗下项目名字。

如果是自己部署的ShowDoc，可以先自行注册一个密码为123456的新用户。然后进数据库，把user表里新用户的password字段覆盖原用户。这样便可以将密码重置为123456。登录后，可在个人设置处改密码。关于如何连接数据库，请看本页面后续问题。

若是自行部署开源版ShowDoc，请确保自己安装好了PHP运行环境

建议按照指示来安装PHP环境。

由于系统、软件版本等情况各不相同，所以如果你一直安装PHP环境失败，可以尝试使用Docker方式部署

开源版showdoc如何连接数据库

showdoc使用sqlite数据库。数据库文件是安装目录下的Sqlite/showdoc.db.php。你可以网络搜索如何在命令行中使用 sqlite数据库.或者使用SQLiteStudio等可视化工具

错误提示”Could not find driver “

请安装php-pdo 和 pdo_sqlite 。

对于Windowns服务器，在php.ini里面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”启用以便开启对SQlite的支持;

Linux服务器安装php5.3以上版本时理论上默认是开启了php-pdo和pdo_sqlite的。如果你安装的PHP依然没有，则可搜索网络教程安装之。

可以使用mysql数据库吗

官方已经不再支持mysql数据库， 如你真的需要强制使用mysql，则可自行二次开发，但官方不提供支持，也请勿浪费时间问官方团队。经过二次开发的版本有可能与官方以后的版本升级冲突导致升级失败，请谨慎考虑

验证码不显示

请检查是否安装了php-gd库

提示验证码验证失败

先到php.ini文件下找找session的保存目录，然后检查安装session目录有没有写入权限，或者可不可能是磁盘空间满了的问题

安装在ubuntu下，一直提示register fail

尝试执行apt-get install php5-sqlite 或者apt-get install php7-sqlite3 以安装sqlite支持

可以关闭注册吗?

编辑文件 server/Application/Api/Controller/UserController.class.php，

在register()里面，这个方法的开头处加上两行代码：

$this->sendError(10101,'不开放注册');return ;

怎么进入管理后台

新安装完成后，默认管理员账号是showdoc/123456 。使用管理员帐户登录后，在项目列表页面的右上角便能看到管理后台入口。如果不能，请重新登录或者刷新浏览器缓存试试

自动脚本和docker安装的showdoc如何绑定域名

不需要对showdoc做操作，请安装个nginx，配置端口映射到本机的4999端口。至于nginx如何绑定域名，可搜索下网络。

ShowDoc更新：

2018年11月

增加快速复制分享链接的功能

为了加强多人多团队情形下的项目协作，正式推出团队管理功能

2018年10月

为了应对复杂项目内容的分类需求，showdoc在原来目录支持的基础上增加一层子目录，支持到了三级目录。用户在新建目录的时候选择父层目录为二级目录即可。

2018年9月

官网showdoc.cc改写了URL转发规则，使分享出去的URL更友好。开源版不支持此功能。

新增一键安装/升级脚本

2018年8月

可通过代码注释自动生成API文档。详情请点击任一个具体项目的项目设置页面-开放API

页面查看的时候增加历史版本的入口

增加对IE11和edge浏览器的兼容支持

登录/注册页面，项目密码页面增加回车快捷键支持

修改个人设置页面在某些浏览器下不能点击返回的bug

修复编辑器在某些情况下预览为空白的bug

修复粘贴上传图片时会重复上传的问题

修复保存文档的快捷键(ctrl+s或command+s)

2018年7月

开源版showdoc新增管理后台功能，可以统一添加、删除用户，以及对全部项目的管理。

2018年4月

支持自动化生成数据字典文档

修复一个sql注入安全漏洞

2018年3月

修复一个跳过验证码注册的bug

修复bugs

2018年2月

使用vue + element框架重构了ShowDoc的前端页面，优化UI风格

提高不同页面之间切换速度

项目展示页面，左侧栏允许收缩

优化目录的添加和管理

2017年11月

禁止上传的文件名后缀为php

禁止空目录名的生成

禁止删除非空的父目录

2017年10月

为了安全性，关闭编辑器对html代码的预览

2017年9月

项目展示页的左侧栏将采用固定布局，不会随着网页下拉而滚动，方便多目录浏览。

项目展示页的新建按钮调整到目录上方，以方便点击。

默认隐藏登录页面和项目密码访问页的验证码，减少用户输入时间。只有当输错密码大于一定次数时才会要求输入验证码。

禁用server 目录缓存，以便在不同服务器之间迁移。迁移直接复制文件夹过去即可

导出word文件的时候可以指定目录

对话框优化

2017年8月

修复编辑器在部分可触屏屏幕下的bug

修复json格式化工具会把number类型转为string的bug

2017年7月

编辑文档时支持直接插入html代码，并支持预览

关闭页面缓存，使修改模板、配置时能立马生效

优化首页展示方式

新增项目归档功能

项目主页可以置顶常用项目

优化目录编辑页面

2017年6月

修复部分浏览器下“点击可放大查看图片”功能与浏览器插件不兼容的bug

2017年5月

图片可以粘贴上传

点击可放大查看图片

显示页面的最后编辑时间和编辑人

2017年4月

项目展示页的左侧栏优化：打开三级目录的页面时，父目录也会展开

支持站内链接

2017年1月

重写项目设置，让交互更友好

新增开放API，可以通过API来批量更新文档

2016年12月

www.showdoc.cc 启用更安全的https

增加logo

增加robots.txt

2016年11月

增加Docker部署方式

创建单页项目功能

复制项目功能

支持单页面分享功能

2016年10月

支持生成TOC目录、科学公式、流程图和序列图

2016年9月

用户可以预览页面历史版本与最新版本的差异

项目创建者可以添加只读成员

2016年8月

完善安装脚本

禁用html缓存、完善页面css样式

完善安装脚本

推出v1.0.0正式版，并支持Composer方式安装

放弃对Mysql的支持，全面使用Sqlite数据库

新增Json格式化工具

完善在线测试API的工具（RunApi）

2016年7月

优化首页，改用全屏单页插件

新增自定义模板功能，允许用户将自己的页面设置为模板

保存页面前可以添加注释。添加的页面注释会在页面的版本历史显示，方便查看页面修改记录

单账户允许同时多处登录（原来只允许同一时间单机登录）

2016年6月

在配置文件可设置上传图片到七牛

用户可设置个性域名

在线ShowDoc域名由doc.star7th.com更改为www.showdoc.cc

增加了多语言的支持

2016年5月

新增自助安装脚本

新增ShowDoc使用交流qq群（群号：564671853）

支持三级目录

历史页面保存到数据库的时候采用压缩，以减少数据库体积

默认使用sqlite数据库

单个页面的历史版本最多保留20个版本，以减少数据库体积

把示例项目和帮助文档指向在线showdoc，以方便以后更新文档是只需要更新在线的即可。showdoc的每个副本也就没必要新建默认项目了

修改URL模式为兼容模式，这样即使不再写apache或者nginx的重定向规则，showdoc也能正常访问

2016年4月

微调详情页的字体样式

修复首页轮播动画

增加了页面标题与地址栏链接变化

优化数据库结构：

增加页面title显示当前项目的名称，同时打开多个项目时方便定位页面

2016年3月

完善左侧栏UI

增加对nginx下重定向规则说明

修复一个自动登录的bug

2016年2月

优化了样式

增加复制页面的功能

web安全：增加SQL过滤防止注入

2016年1月

URL不区分大小写

新增快捷键操作

2015年12月

增加对删除页面的权限细分控制

新增图片上传功能

增加文档搜索功能

删除页面和目录前增加确认按钮以防误操作

2015年11月

ShowDoc诞生并开源