- 软件介绍
- 软件截图
ShowDoc是一款在线API文档编写工具，软件采用markdown编辑器，用户可以通过它快速编写出美观的API文档，支持从代码自动生成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;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来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。
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
