ShowDoc是一款线上API文档撰写专用工具，软件选用markdown编辑器，客户能够根据它迅速编写出美观大方的API文档，适用从编码自动生成API，能够开展团队协作、分配任务，简易好用，功能完善。

cad23cedc673cb2478e4f9 alt="ShowDoc(API文档编辑工具)">

【功能介绍】

1、共享与导出来

响应式网站网页制作，可将项目文档发送到电脑上或移动设备查询。另外还可以将项目导出来成word文档，便于离线浏览。

2、编辑作用

（1）markdown编辑

ShowDoc选用markdown编辑器，不论是编辑還是阅读文章感受都极好非常好。假如你没掌握Markdown，请在百度搜索引擎检索”了解与新手入门 Markdown”

（2）模板插进

在ShowDoc的编辑网页页面，点一下编辑器上边的按键可便捷地插进API插口模板和数据流图模板。插进模板后，剩余的便是修改数据信息了，省掉了许多 编辑的气力。

（3）历史版本

ShowDoc为网页页面出示历史版本作用，你能便捷地把网页页面修复到以前的版本号。

3、管理权限

（1）公布项目与私秘项目

ShowDoc上的项目有公布项目和私秘项目二种。公布项目可供一切登陆和非登陆的客户浏览，而私秘项目则必须输入支付密码认证浏览。登陆密码由项目创始人设定。

（2）项目出让

项目创始人能够随意地把项目出让给网址的普通用户。

（3）项目组员

你能很便捷地为ShowDoc的项目加上、删掉项目组员。项目组员能够对项目开展编辑，但不能出让或删掉项目（仅有项目创始人才有管理权限）

（4）团队协作

你能填加好几个精英团队，为精英团队分派不一样的项目，另外设定精英团队里每一个人的管理权限。

【软件主要用途】

1、API文档

伴随着移动互联的发展趋势，BaaS（后端开发即服务项目）愈来愈时兴。服务器端出示API，APP端或是网页页面前端开发便可便捷启用数据信息。用ShowDoc能够十分便捷迅速地编写出美观大方的API文档，另外还将适用从编码文档中自动生成API文档

2、数据流图

一份好的数据流图能够很便捷地为他人表明你的数据库查询构造，如每个字段名的释意等。

3、表明文档

你彻底能够应用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