Showdoc一个非常适合IT团队的在线API文档、技术文档工具。这款工具采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。通过它你可以非常方便快速地编写出美观的API文档,支持从代码文件中自动生成API文档,同时你可以自行添加多个团队,为团队分配不同的项目,同时设置团队里每个人的权限。太平洋下载中心为您提供Showdoc官方版下载。
ShowDoc截图1
功能介绍:
1、分享与导出
响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。
2、编辑功能
(1)markdown编辑
ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown,请在搜索引擎搜索”认识与入门 Markdown”
(2)模板插入
在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。
(3)历史版本
ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
3、权限管理
(1)公开项目与私密项目
ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。
(2)项目转让
项目创建者可以自由地把项目转让给网站的其他用户。
(3)项目成员
你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)
(4)团队管理
你可以自行添加多个团队,为团队分配不同的项目,同时设置团队里每个人的权限。
ShowDoc截图2
ShowDoc截图3
使用方法:
安装:
#下载脚本并赋予权限
wget https://www.showdoc.cc/script/showdoc;chmod +x showdoc;
#默认安装中文版。如果想安装英文版,请加上en参数,如 ./showdoc en
./showdoc
其他命令:
#执行上面命令便会自动安装完成。下面附上脚本其他命令,以便管理showdoc时可以用得上。
#停止
./showdoc stop
#重启
./showdoc restart
#升级showdoc到最新版
./showdoc update
#卸载showdoc
./showdoc uninstall
ShowDoc截图4
安装步骤:
1、在本站下载该软件压缩包
2、解压得到该软件,打开即可使用
ShowDoc截图5
常见问答:
1、忘记了密码怎么办?
如果是使用在线ShowDoc(//www.showdoc.cc ),忘记密码的话可联系xing7th@gmail.com,邮件中说明你的用户名和旗下项目名字。
如果是自己部署的ShowDoc,则首先根据前面安装文档进行升级,确保使用最新代码(划重点)。然后,根据安装方式的不同有不同的密码重置方式。
如果是使用官方脚本或者docker方式安装的,请在命令行执行命令:
docker exec showdoc php /var/www/html/index.php home/common/repasswd
如果是手动安装php方式的,则在命令行中切换到web目录然后执行:
php index.php home/common/repasswd
以上命令会把管理员showdoc的密码重置为123456 。用此密码登录管理后台即可管理普通用户以及项目。建议登录后修改密码。
若修改密码出错,请确保自己采用最新版代码。
2、开源版showdoc如何连接数据库
showdoc使用sqlite数据库。数据库文件是安装目录下的Sqlite/showdoc.db.php。你可以网络搜索如何在命令行中使用 sqlite数据库.或者使用SQLiteStudio等可视化工具
3、错误提示 “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依然没有,则可搜索网络教程安装之。
4、错误提示”General error: 11 database disk image is malformed”
请确保服务器安装好了php环境和php-sqlite扩展;
如果你以FTP方式上传代码到服务器,那么请使用二进制模式上传,否则会损害数据库文件,导致此错误提示
更新日志:
Showdoc v2.4.0更新日志:
1、界面简洁友好
2、性能体验优化提升
3、修复了已知bug
编辑点评:
Showdoc官方版是一款专业高效的在线API文档编辑工具,Showdoc官方版功能强劲便捷好用,支持用户从代码文件中自动生成API文档,同时你可以自行添加多个团队,为团队分配不同的项目,以此来提高整体的办公效率。本站为你提供Showdoc官方下载。