diff --git a/apps/showdoc/3.2.2/data.yml b/apps/showdoc/3.2.2/data.yml new file mode 100755 index 00000000..1e1ccc91 --- /dev/null +++ b/apps/showdoc/3.2.2/data.yml @@ -0,0 +1,9 @@ +additionalProperties: + formFields: + - default: 4999 + envKey: PANEL_APP_PORT_HTTP + labelEn: Port + labelZh: 端口 + required: true + rule: paramPort + type: number diff --git a/apps/showdoc/3.2.2/docker-compose.yml b/apps/showdoc/3.2.2/docker-compose.yml new file mode 100644 index 00000000..a668da94 --- /dev/null +++ b/apps/showdoc/3.2.2/docker-compose.yml @@ -0,0 +1,19 @@ +version: '3' +services: + showdoc: + image: star7th/showdoc:v3.2.2 + container_name: ${CONTAINER_NAME} + restart: always + networks: + - 1panel-network + ports: + - ${PANEL_APP_PORT_HTTP}:80 + tty: true + volumes: + - /showdoc_data:/showdoc_data_old + - ./showdocdata/html:/var/www/html + labels: + createdBy: "Apps" +networks: + 1panel-network: + external: true \ No newline at end of file diff --git a/apps/showdoc/README.md b/apps/showdoc/README.md new file mode 100644 index 00000000..34d7f435 --- /dev/null +++ b/apps/showdoc/README.md @@ -0,0 +1,9 @@ +# ShowDoc + +**ShowDoc** 是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。 + +## 主要功能: + +- **API文档**:随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。 +- **数据字典**:一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。 +- **说明文档**:你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。 \ No newline at end of file diff --git a/apps/showdoc/data.yml b/apps/showdoc/data.yml new file mode 100755 index 00000000..f0cc32f6 --- /dev/null +++ b/apps/showdoc/data.yml @@ -0,0 +1,20 @@ +name: ShowDoc +tags: + - DevOps +title: 一个非常适合IT团队的在线API文档、技术文档工具 +type: DevOps +description: 一个非常适合IT团队的在线API文档、技术文档工具 +additionalProperties: + key: showdoc + name: ShowDoc + tags: + - DevOps + shortDescZh: 一个非常适合IT团队的在线API文档、技术文档工具 + shortDescEn: ShowDoc is a tool greatly applicable for an IT team to share documents online + type: tool + crossVersionUpdate: false + limit: 0 + recommend: 0 + website: https://www.showdoc.com.cn/ + github: https://github.com/star7th/showdoc + document: https://www.showdoc.com.cn/help diff --git a/apps/showdoc/logo.png b/apps/showdoc/logo.png new file mode 100644 index 00000000..31024f07 Binary files /dev/null and b/apps/showdoc/logo.png differ