showdoc电脑版(api文档工具)是一款专门用于API文档编写的软件。showdoc电脑版(api文档工具)支持响应式网页设计,可将项目文档分享到电脑或移动设备查看,可以有效的提高团队的工作效率。系统城给大家提供了showdoc免费客户端安装包下载,还有使用方法,有需要的朋友快来下载吧。
showdoc功能介绍
1、分享与导出
响应式网页设计,可将项目文档分享到电脑或移动终端查看。同时也可以将项目导出成word文件,便于离线浏览。
2、编辑功能
(1)markdown编写
ShowDoc选用markdown编辑器,无论是编写还是阅读体验都很好很棒。倘若你不了解Markdown,请在搜索引擎搜索”了解与入门Markdown”
(2)模版插进
在ShowDoc的编辑页面,点击编辑器上方的按键可方便地插进API接口模版和数据字典模版。插进模版后,剩下的就是改动数据了,免去了很多编写的力气。
(3)历史版本
ShowDoc为页面提供历史版本功效,你可以方便地把页面恢复到以前的版本。
3、管理权限
(1)公开项目与私密项目
ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录和非登录的用户访问,而私密项目就需要输入密码验证访问。密码由项目创始人设置。
(2)项目转让
项目创始人可以任意地把项目转让给网站的其他用户。
(3)项目成员
你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编写,但不可转让或删除项目(只有项目创始人才有权限)
(4)团队协作
你可以自行添加多个团队,为团队分配不同的项目,同时设置团队里每一个人权限。
showdoc特色说明
1、适用markdown语法(所有的api接口创作现在都适用这个吧,因为他如今太方便了);
2、适用多客户合作,你可以在项目下面随意添加多个用户一起完成api文档的写作;
3、适用项目转让;
4、倘若在线使用,可以设置自己的个性域名,还能够对文档进行加密,浏览者务必密码才能访问;
5、能通过一个在线测试api的工具,直接生成markdown,你几乎不用敲代码就能过所有的参数一键生成;
6、适用模版插进;
7、适用历史版本,你可以把操作恢复到以前的版本;
8、完全开源;
9、可以部署到自己的服务器;
10、可以分享并导出项目,生成需要的文档格式如doc,可以离线浏览;
11、适用响应式,手机电脑一样精彩。
showdoc使用方法
安装:
#下载脚本并赋予权限
wget https://m.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