ShowDoc(在线API文档编辑工具)

showdoc是一种非常适用于团队使用的在线API文档编写工具，它提供了简洁、直观的界面和丰富的功能，帮助开发团队快速编写出舒适的API文档。使用showdoc，团队成员可以方便地创建、编辑和管理API文档，共享给其他团队成员进行查看和使用。showdoc支持多人协作编辑，可以轻松实现团队成员的文档协作。showdoc提供了丰富的编辑工具，包括Markdown语法支持、代码高亮、引用、列表、表格等，使得编写文档变得简单、灵活。showdoc还提供了友好的接口管理功能，可以方便地创建和管理API接口。通过接口管理功能，可以快速构建和维护API文档，包括接口的请求地址、请求方式、参数、返回结果等。

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

亮点

showdoc的用户权限管理功能也非常完善，可以根据团队成员的不同角色，设置对应的访问权限。这样，团队成员可以根据自己的权限进行文档的编辑、查看和评论，有效控制文档的安全性和可访问性。

showdoc还提供了强大的搜索功能，可以快速定位到需要的文档内容。无论是团队内部成员还是外部合作伙伴，都可以通过搜索功能快速找到所需的文档，提高工作效率。

ShowDoc软件用途

1、API文档

随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档，同时还将支持从代码文件中自动生成API文档

2、数据字典

一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。

3、说明文档

你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。

ShowDoc功能

1、分享与导出
自适应网站网页设计，可将项目文档分享到电脑或移动终端查看。此外，项目还可以导出到word文档中，便于离线浏览。
2、编写功效
(1)markdown编写
Showdoc采用markdown编辑器，无论是编辑还是阅读体验都非常好。如果您不掌握Markdown，请在搜索引擎中搜索“了解与初学者Markdown”
(2)插入模板
在Showdoc的编辑网站页面上，点击编辑器上的按钮，方便插入API插孔模板和数据流图模板。插入模板后，剩下的就是修改数据信息，节省了很多编辑的精力。
(3)历史版
Showdoc为网站页面提供历史版本功效，您可以方便地将网站页面修复到之前的版本号。
3、管理权限
(1)发布项目和私秘项目
Showdoc上的项目有两个发布项目和私人秘密项目。发布项目可以访问所有登录和非登录的用户，而私人秘密项目需要输入交易密码来验证访问。登录密码由项目创始人设置。
(2)项目转让
项目创始人可以随意将项目交给网站的一般用户。
(3)项目成员
您可以很容易地添加和删除showdoc项目的成员。项目成员可以编写项目，但不能转让或删除项目（只有项目创始人有管理权限）
(4)团结协作
您可以添加许多优秀的团队，为优秀的团队分配不同的项目，并设置优秀团队中每个人的管理权限。



showdoc是一款适用于团队使用的在线API文档编写工具，它的简洁、直观的界面、丰富的功能和强大的搜索功能，能够帮助团队快速编写出舒适的API文档，提高团队的协作效率。