Showdoc是一款非常适合IT团队的在线技术文档、API文档工具。非常实用，便于加快团队之间沟通的效率，用这款软件可以非常方便快速地编写出美观的API文档，同时还将支持从代码文件中自动生成API文档。可以用于编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。有需要的朋友可以前来本站下载体验！
软件特色
1、支持markdown语法（所有的api接口写作现在都支持这个吧，因为他现在太方便了）
2、支持多用户协作，你可以在项目下面随意添加多个用户一起完成api文档的写作。
3、支持项目转让
4、如果在线使用，可以设置自己的个性域名，也可以对文档进行加密，浏览者需要密码才能访问
5、可以通过一个在线测试api的工具，直接生成markdown，你几乎不用写代码就能过所有的参数自动生成
6、支持模版插入
7、支持历史版本，你可以把操作恢复到以前的版本。
8、完全开源
9、可以部署到自己的服务器
10、可以分享并导出项目，生成需要的文档格式如doc，可以离线浏览
11、支持响应式，手机电脑同样精彩
软件功能
一、分享与导出响应式网页设计，可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件，以便离线浏览。
二、编辑功能1、markdown编辑
采用markdown编辑器，无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown，请在搜索引擎搜索”认识与入门 Markdown”
2、模板插入
在软件的编辑页面，点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后，剩下的就是改动数据了，省去了很多编辑的力气。
3、历史版本
为页面提供历史版本功能，你可以方便地把页面恢复到之前的版本。
三、权限管理1、公开项目与私密项目
软件上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问，而私密项目则需要输入密码验证访问。密码由项目创建者设置。
2、项目转让
项目创建者可以自由地把项目转让给网站的其他用户。
3、项目成员
你可以很方便地为软件的项目添加、删除项目成员。项目成员可以对项目进行编辑，但不可转让或删除项目（只有项目创建者才有权限）
4、团队管理
你可以自行添加多个团队，为团队分配不同的项目，同时设置团队里每个人的权限。
软件优势
1、API文档随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档，同时还将支持从代码文件中自动生成API文档
2、说明文档你完全可以使用它来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。
3、数据字典一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。
常见问题
1、提示验证码验证失败先到php.ini文件下找找session的保存目录，然后检查安装session目录有没有写入权限，或者可不可能是磁盘空间满了的问题
2、可以关闭注册吗？编辑文件 server/Application/Api/Controller/UserController.class.php，
在register()里面，这个方法的开头处加上两行代码：
$this->sendError(10101,'不开放注册');
return ;
3、开源版如何连接数据库使用sqlite数据库。数据库文件是安装目录下的Sqlite/showdoc.db.php。你可以网络搜索如何在命令行中使用 sqlite数据库.或者使用SQLiteStudio等可视化工具
4、错误提示”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依然没有，则可搜索网络教程安装之。
更新日志
v2.4.0（2019-07-30）
1、可通过代码注释自动生成API文档。详情请点击任一个具体项目的项目设置页面-开放API
2、页面查看的时候增加历史版本的入口
3、增加对IE11和edge
浏览器的兼容支持
4、登录/注册页面，项目密码页面增加回车快捷键支持
5、修改个人设置页面在某些浏览器下不能点击返回的bug
6、修复编辑器在某些情况下预览为空白的bug
7、修复粘贴上传图片时会重复上传的问题
8、修复保存文档的快捷键(ctrl+s或command+s)
2018年2月
1、使用vue + element框架重构了ShowDoc的前端页面，优化UI风格
2、提高不同页面之间切换速度
3、项目展示页面，左侧栏允许收缩
4、优化目录的添加和管理
0条评论