ShowDoc客户端下载|ShowDoc(API文档编辑器) v2.4.0官方版下载
ShowDoc是一款采用markdown编辑器的API文档编辑器!用户可以使用它来创作出精美的API文档!它还支持从代码自动生成API,功能强大!可以让团队分工合作、任务分配,简单实用。
ShowDoc功能介绍
1.共享导出。
响应性网页设计,知识兔可以将项目文档共享给计算机或移动设备进行查看。同时,还可以将项目导出到word文件中进行脱机浏览。
2.编辑功能。
(1)降价编辑。
ShowDoc使用markdown编辑器,编辑阅读体验极佳。如果知识兔您不知道Markdown,请在搜索引擎中搜索“了解和开始使用Markdown”
(2)模板插入。
在ShowDoc的编辑页面,知识兔点击编辑器上方的按钮,知识兔可以方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是修改数据了,省去了大量的编辑工作。
(3)版本历史。
ShowDoc为页面分享了版本历史功能,因此您可以轻松地将页面恢复到以前的版本。
3.权限管理。
(1)公共项目和私人项目。
ShowDoc上有两种项目:公共项目和私有项目。任何已登录和未登录的用户都可以访问公共项目,而私有项目需要密码验证。密码由项目创建者设置。
(2)项目转让。
项目创建者可以自由地将项目转移给网站的其他用户。
(3)项目成员。
您可以轻松地为ShowDoc项目添加和删除项目成员。项目成员可以编辑项目,但不能转移或删除项目(只有项目创建者有权限)
(4)团队管理。
您可以自己添加多个团队,为团队分配不同的项目,并为团队中的每个人设置权限。
ShowDoc软件用途
1.API文件。
随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务方面分享API,APP方面和web前端容易调用数据。使用ShowDoc可以非常方便快捷地编写美丽的API文件,同时支持从代码文件中自动生成API文件。
2.数据字典。
一个好的数据字典可以很容易地向别人解释你的数据库结构,如各个字段的解释。
3.说明文件。
可以使用showdoc制作工具说明书,知识兔也可以制作技术规范说明书供团队查阅。
ShowDoc使用方法
安装:
#下载脚本并赋予权限
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
更新日志
1、界面简洁友好
2、性能体验优化提升
3、修复了已知bug
下载仅供下载体验和测试学习,不得商用和正当使用。