Showdoc是一款专业的在线API文档、技术文档工具,采用业界知名的采用markdown编辑器,可进行API接口模板和数据字典模板的插入,还可编写说明文档,提供了安全的文档数据托管服务,保证您文档的安全性。推荐有需要的朋友下载!
软件功能
1、分享与导出
响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。
2、权限管理
公开项目与私密项目
ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。
项目转让
项目创建者可以自由地把项目转让给网站的其他用户。
项目成员
你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)
团队管理
你可以自行添加多个团队,为团队分配不同的项目,同时设置团队里每个人的权限。
3、编辑功能
markdown编辑
ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown,请在搜索引擎搜索”认识与入门 Markdown”
模板插入
在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。
历史版本
ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
软件特点
1、API文档
APP、web前端与服务器常用API来进行交互
用ShowDoc可以非常方便快速地编写出美观的API文档
2、数据字典
好的数据字典可以很方便地向别人描述你的数据库结构
用ShowDoc可以编辑出美观的数字字典
3、说明文档
你完全可以使用 ShowDoc来编写一些工具的说明书
也可以编写一些技术规范说明文档以供团队查阅
4、团队协作
团队权限管理机制让团队良好地协同编写文档
5、免费开源
ShowDoc提供免费开源的版本
你可以选择将ShowDoc部署到你的服务器
6、在线托管
提供安全稳定的在线文档托管服务
你可以放心地选择托管你的文档数据在云端
Showdoc使用方法
如何迁移数据库
备份所有代码和数据库
下载新代码:https://github.com/star7th/showdoc
将新代码中的/Sqlite/ 复制到旧目录(如果已存在/Sqlite则覆盖之),并赋予/Sqlite/showdoc.db.php可写权限
复制新代码中的/Application/Home/Controller/UpdateController.class.php 覆盖原来旧的相应文件。
在浏览器访问:http://xxxx.com/index.php?s=/home/update/toSqlite ,看到ok提示后,mysql的数据已经写入/Sqlite/showdoc.db.php
此时,除了/Sqlite/showdoc.db.php文件外,旧目录的其他所有文件全部用新下载的文件覆盖。注意清理runtime缓存以及保留原来文件夹权限的设定。具体哪些文件需要权限,可参考部署手册。
常见问题
1、开源版showdoc如何连接数据库
showdoc使用sqlite数据库。数据库文件是安装目录下的Sqlite/showdoc.db.php。你可以网络搜索如何在命令行中使用 sqlite数据库.或者使用SQLiteStudio等可视化工具
2、错误提示”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依然没有,则可搜索网络教程安装之。
3、验证码不显示
请检查是否安装了php-gd库
4、提示验证码验证失败
先到php.ini文件下找找session的保存目录,然后检查安装session目录有没有写入权限,或者可不可能是磁盘空间满了的问题
5、安装在ubuntu下,一直提示register fail
尝试执行apt-get install php5-sqlite 或者apt-get install php7-sqlite3 以安装sqlite支持
更新日志
为了加强多人多团队情形下的项目协作,正式推出团队管理功能