ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。

官方文档

ShowDoc

环境

ubuntu 20.04

1.安装docker

Ubuntu 安装Docker 运行Nginx-CSDN博客

2.安装docker-compose 

Ubuntu 安装 docker-compose-CSDN博客

3.编写shell脚本

vim shart.sh
#!/bin/bash

# 创建目录结构
rm -r /docker/showdoc
mkdir -p /docker/showdoc/data

# 进入目标目录
cd /docker/showdoc

# 将内容写入 docker-compose.yml 文件
cat <<EOF > docker-compose.yml
services:
  showdoc:
    image: star7th/showdoc
    container_name: showdoc
    privileged: true
    user: root
    volumes:
      - /docker/showdoc/data:/var/www/html/
    ports:
      - "8093:80"
    restart: unless-stopped
    environment:
      - TZ=Asia/Shanghai
EOF

# 启动 Docker Compose
docker compose up -d

4.启动shell脚本

sh start.sh

5.打开网页,开始使用

http://<主机IP>:8093/ 

初始账号密码   showdoc/123456 

Logo

北京人形旗下天工造物具身智能开源社区,聚焦具身天工与慧思开物两大平台

更多推荐