ShowDoc

ShowDoc是一款优秀的在线文档管理工具，致力于帮助开发团队高效地创建、共享和维护项目文档，它提供了简洁清晰的界面设计以及丰富的编辑工具，让团队成员能够轻松创建详细的接口文档、使用说明和设计文档等，ShowDoc支持团队协作功能，让团队成员可以方便地共同编辑和评论文档，实现协作进程的高效管理，ShowDoc还提供了项目权限管理和版本控制等功能，帮助开发团队更好地管理和追踪文档的更新和变更。

特色特性

1、支持对一些的比较复杂的模块设计介绍类型的API文档

2、ShowDoc软件提供良好的markdown编辑器

3、在ShowDoc的编辑页面，点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后，剩下的就是改动数据了，省去了很多编辑的力气

4、API文档在很多场合都可以使用，支持对新开发项目制作API文档

5、适合在开发大型项目以及团队项目的时候制作API文档

使用步骤

安装：

#下载脚本并赋予权限

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

更新变更

1、界面简洁友好

2、性能体验优化提升

3、修复了已知bug

功能分析

1、共享与导出来

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

2、编辑作用

(1)markdown编辑

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

(2)模板插进

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

(3)历史版本

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

3、管理权限

(1)公布项目与私秘项目

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

(2)项目出让

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

(3)项目组员

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

(4)团队协作

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