Update README

This commit is contained in:
2026-05-19 22:49:37 +08:00
parent 46b44d771d
commit 0aadc1ae9b

View File

@@ -37,6 +37,10 @@ DOCS_DIR=./docs
### 2. 构建并启动服务 ### 2. 构建并启动服务
下载当前的docker-compose.yml文件放到项目根目录
运行以下命令构建并启动服务:
```bash ```bash
# 构建镜像并启动服务 # 构建镜像并启动服务
docker-compose up --build docker-compose up --build
@@ -45,6 +49,26 @@ docker-compose up --build
docker-compose up --build -d docker-compose up --build -d
``` ```
**需要创建文档服务最小目录单元**
```
hf-mes-docs-vitepress/
├── docs/ # VitePress 文档目录 **生产时使用**
│ ├── .vitepress/
│ │ ├── config.mjs # VitePress 配置
│ │ ├── vitepress-pdf.config.ts # PDF 导出配置
│ │ └── theme/
│ │ ├── index.ts # 自定义主题入口,图片放大缩小配置
│ │ └── style/
│ │ └── print.css # 打印样式用于pdf导出
│ ├── index.md # 首页
│ ├── guide/ # 指南目录(可选)
│ ├── getting-started/ # 入门目录(可选)
│ └── ... # 其他文档(可选)
├── docker-compose.yml # Docker Compose 配置
└── .env # 环境变量配置
```
### 3. 验证服务状态 ### 3. 验证服务状态
访问以下地址确认服务正常运行: 访问以下地址确认服务正常运行:
@@ -52,27 +76,31 @@ docker-compose up --build -d
- **VitePress 文档**: http://localhost:3000 - **VitePress 文档**: http://localhost:3000
- **API 健康检查**: http://localhost:3001/health - **API 健康检查**: http://localhost:3001/health
## 目录结构 ## 目录结构(全项目)
``` ```
hf-mes-docs-vitepress/ hf-mes-docs-vitepress/
├── docker/ ├── docker/
│ ├── api/ │ ├── api/
│ │ ├── server.js # API 服务主文件 │ │ ├── server.js # API 服务主文件
│ │ └── package.json # API 依赖 │ │ └── package.json # API 依赖
│ ├── Dockerfile # Docker 镜像构建文件 │ ├── Dockerfile # Docker 镜像构建文件
│ └── docker-entrypoint.sh # 容器启动脚本 │ └── docker-entrypoint.sh # 容器启动脚本
├── docs/ # VitePress 文档目录 **生产时使用** ├── docs/ # VitePress 文档目录 **生产时使用**
│ ├── .vitepress/ │ ├── .vitepress/
│ │ ├── config.mjs # VitePress 配置 │ │ ├── config.mjs # VitePress 配置
│ │ ── vitepress-pdf.config.ts # PDF 导出配置 │ │ ── vitepress-pdf.config.ts # PDF 导出配置
├── index.md # 首页 │ └── theme/
├── guide/ # 指南目录 │ ├── index.ts # 自定义主题入口,图片放大缩小配置
├── getting-started/ # 入门目录 │ └── style/
└── ... # 其他文档 └── print.css # 打印样式用于pdf导出
├── docker-compose.yml # Docker Compose 配置 │ ├── index.md # 首页
├── package.json # 项目依赖 **构建docker时使用** │ ├── guide/ # 指南目录(可选)
└── .env # 环境变量配置 │ ├── getting-started/ # 入门目录(可选)
│ └── ... # 其他文档(可选)
├── docker-compose.yml # Docker Compose 配置
├── package.json # 项目依赖 **构建docker时使用**
└── .env # 环境变量配置
``` ```
## 常用命令 ## 常用命令