【介绍】

ShowDoc可以用于写作API文档，它内置markdown编辑器，保留了经典的编辑与阅读体验，并且支持进行API接口和数据字典模板的插入。此工具能够保留编辑页面的历史版本，一旦发现错误，可以快捷地将页面恢复到之前的版本。

软件性能

1、分享与导出

呼应式网页设计，可将项目文档分享到电脑或挪动产品检查。同时也能够将项目导出成word文件，以便离线阅读。

2、编纂性能

（1）markdown编纂

采取markdown编纂器，不管是编纂仍是图书浏览感受都极佳很棒。若是你不领会Markdown，请在搜刮引擎搜刮熟悉与入门 Markdown

（2）模板拔出

在此程序的编纂页面，点击编纂器上方的操控键位可便利地拔出API接口模板和数据字典模板。拔出模板后，剩下的就是改动数据了，省去了良多编纂的气力。

（3）史记版本

为页面供给史记版本性能，你可以便利地把页面恢复到之前的版本。

3、权限办理

（1）公然项目与私密项目

此程序上的项目有公然项目和私密项目两种。公然项目可供任何登录与非登录的用户拜候，而私密项目则需求输出密码验证拜候。密码由项目建立者设置。

（2）项目让渡

项目建立者可以自在地把项目让渡给网站的其他用户。

（3）项目成员

你可以很便利地为此程序的项目加入、删除项目成员。项目成员可以对项目开启编纂，但不成让渡或删除项目（只要项目建立者才有权限）

（4）团队办理

你可以自行加入多个团队，为团队分派各种的项目，同时设置团队里每一个人的权限。

软件性能

1、API文档

跟着挪动互联网的成长，BaaS（后端即服务）愈来愈风行。服务端供给API，APP端或网页前端即可便利挪用数据。用此程序可以很是便利迅速地编写出美观的API文档，同时还将拥有从代码文件中主动转换API文档

2、数据字典

一份好的数据字典可以很便利地向他人申明你的信息库布局，如各个字段的释义等。

3、申明文档

你完全可使用此程序来编写一些东西的申明书，也能够编写一些功能标准申明文档以供团队查阅。

此程序运用方式

装载：

#下载脚本并付与权限

wget https://www.此程序.cc/script/showdoc;ch mod +x showdoc;

#默许装载中文版。若是想装载英文版，请加上en参数，如 。/ en

其他指令：

#履行下面指令便会主动装载完成。上面附上脚本其他指令，以便办理此程序时可以用得上。

#遏制

./此程序 stop

#重启

./此程序 restart

#进级此程序到最新版

./此程序 update

#卸载此程序

./此程序 uninstall

小编测评

此工具支持开发者预先编辑API文档模板，后续使用时直接插入模板，然后更新一下其中包含的数据等信息，节省了不少时间。它拥有权限管理系统，创建者可以为项目添加、删除成员，而且项目成员只能对项目进行编辑，不可转让或删除。

以上就是软件爱好者小编今日为大家带来的ShowDoc，更多软件下载尽在软件爱好者。