【开源项目】ShowDoc适合IT团队的在线API文档、技术文档工具

1. 介绍

通过showdoc，可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。还可以利用showdoc的自动化能力，从程序注释中自动生成API文档，或者从搭配的RunApi客户端（类似postman的api调试工具）中一边调试接口、一边自动生成文档。支持多平台客户端。

2. 需要环境

2.1 硬件需求

CPU：至少1核
内存：推荐≥1G
硬盘：无特殊要求

2.2 软件需求

需要Linux系统，Docker、Docker-Compose，环境安装见《必备的Docker和Dockercompose环境安装》,本安装环境均基于Debian11。

3.部署

3.1 Docker-Compose方式安装

# 切换到root权限
sudo -i
# 创建数据文件夹
mkdir /etc/docker/showdoc && cd /etc/docker/showdoc

# 编辑docker-compose文件
vim docker-compose.yaml     

version: "3"
services:
  showdoc:
    image: star7th/showdoc:3.2.6
    container_name: showdoc
    restart: always
    ports:
      - 8008:80 # 默认80端口
    tty: true
    volumes:
      - /etc/docker/showdoc/showdoc_data:/showdoc_data_old
      - /etc/docker/showdoc/html:/var/www/html

复制上述配置文件内容，shift+ins 粘贴文本后，输入 :wq 退出保存

#启动安装服务
docker-compose up -d

4.使用配置

登录ip:8008，选择中文

初始账户:showdoc 初始密码：123456