feat: add ShowDoc (#480)

This commit is contained in:
wanghe 2023-10-10 02:38:45 -05:00 committed by GitHub
parent 870b47e3c0
commit 8309abd75d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 57 additions and 0 deletions

9
apps/showdoc/3.2.2/data.yml Executable file
View File

@ -0,0 +1,9 @@
additionalProperties:
formFields:
- default: 4999
envKey: PANEL_APP_PORT_HTTP
labelEn: Port
labelZh: 端口
required: true
rule: paramPort
type: number

View File

@ -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

9
apps/showdoc/README.md Normal file
View File

@ -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后端即服务越来越流行。服务端提供APIAPP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。
- **数据字典**:一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
- **说明文档**你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。

20
apps/showdoc/data.yml Executable file
View File

@ -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

BIN
apps/showdoc/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB