ShowDoc

ShowDoc是一款专业的API文档编辑软件，软件采用markdown编辑器，用户可以使用 markdown 语法来书写出美观的 API 文档、数据字典文档、技术文档、在线 excel 文档等等。此外ShowDoc还拥有强大的自动化功能，可以从代码注释中自动生成文档，大大提高团队之间沟通的效率。KK下载站为您提供ShowDoc官方免费版下载，软件使用完全免费，有需要的朋友赶紧下载吧！


 

ShowDoc使用说明

安装：
#下载脚本并赋予权限

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

#默认安装中文版。如果想安装英文版，请加上en参数，如 ./showdoc en

./showdoc

其他命令：

#执行上面命令便会自动安装完成。下面附上脚本其他命令，以便管理showdoc时可以用得上。

#停止

./showdoc stop

#重启

./showdoc restart

#升级showdoc到最新版

./showdoc update

#卸载showdoc

./showdoc uninstall


 

ShowDoc功能介绍

1.分享和导出
响应式网页设计设计，您可以与计算机或移动设备共享项目文档。同时，您还可以导出项目word离线浏览文件。
2.编辑功能
（1）markdown编辑
ShowDoc采用markdown编辑器在编辑和阅读体验方面都很出色。如果你不知道Markdown，请搜索搜索引擎”认识与入门Markdown”
(2)插入模板
在ShowDoc点击编辑器上方的按钮，轻松插入编辑器的编辑页面API接口模板和数据字典模板。插入模板后，剩下的就是更改数据，节省了大量的编辑能力。
(3)历史版本
ShowDoc为页面提供历史版本功能，您可以轻松地将页面恢复到之前的版本。
3.权限管理
(1)公开项目和私人项目
ShowDoc上述项目包括公共项目和私人项目。任何登录和非登录用户都可以访问公共项目，而私人项目需要输入密码进行验证。密码由项目创建者设置。
(2)项目转让
项目创建者可以自由地将项目转移到网站的其他用户。
(3)项目成员
可以很方便的做ShowDoc的项目添加.删除项目成员。项目成员可以编辑项目，但不能转让或删除项目(只有项目创建者有权限)
(4)团队管理
您可以自行添加多个团队，为团队分配不同的项目，并在团队中设置每个人的权限。
 

ShowDoc软件特色

1.API文档
随着移动互联网的发展，BaaS(后端即服务)越来越受欢迎。服务器提供API，APP终端或网页前端可以方便地调用数据。ShowDoc它可以非常方便和快速地快捷API同时，还将支持代码文件的自动生成API文档
2.数据字典
一个好的数据字典可以很容易地向别人解释你的数据库结构，比如每个字段的解释。
3.说明文档
你可以完全使用它showdoc为了编写一些工具说明书，也可以编写一些技术规范说明书供团队查阅。