Message-Push-Nest/docs/SETUP.md

VitePress 文档站点设置完成

已完成的工作

✅ 创建了完整的 VitePress 文档站点结构 ✅ 根据 README.md 拆分内容到多个文档页面 ✅ 配置了导航和侧边栏 ✅ 安装了所有必要的依赖 ✅ 创建了美观的首页

文档结构

docs/
├── .vitepress/
│   └── config.mts           # VitePress 配置文件
├── guide/                   # 指南部分
│   ├── introduction.md      # 项目介绍
│   ├── features.md          # 特色功能
│   ├── changelog.md         # 更新日志
│   ├── configuration.md     # 完整配置说明
│   └── embed-html.md        # EmbedHtml 配置详解
├── deployment/              # 部署部分
│   ├── overview.md          # 部署概览
│   ├── direct-run.md        # 直接运行 Release
│   ├── development.md       # 开发调试模式
│   ├── docker.md            # Docker 部署
│   └── docker-compose.md    # Docker Compose 部署
├── api/                     # API 文档
│   ├── usage.md             # API 使用说明
│   └── examples.md          # 多语言调用示例
├── public/
│   └── logo.svg             # 站点 Logo
├── index.md                 # 首页
├── package.json             # 项目配置
└── README.md                # 文档说明

快速开始

启动开发服务器

cd docs
npm run docs:dev

访问：http://localhost:5173

构建生产版本

cd docs
npm run docs:build

构建产物在 docs/.vitepress/dist 目录

预览构建结果

cd docs
npm run docs:preview

文档内容

指南部分

• 介绍 - 项目背景、演示站点、效果图
• 特色功能 - 核心特性、支持的推送方式、其他功能
• 更新日志 - 完整的功能更新历史
• 配置说明 - 详细的配置文件说明和示例
• EmbedHtml说明 - 单应用模式和前后端分离模式的详细说明

部署部分

• 部署概览 - 各种部署方式对比和快速选择指南
• 直接运行 - 使用 Release 可执行文件部署
• 开发调试 - 本地开发环境搭建
• Docker部署 - 两种 Docker 部署方式（配置文件和环境变量）
• Docker Compose - 完整的编排部署方案

API 文档

• 使用说明 - API 接口说明、参数、响应格式
• 调用示例 - 提供 CURL、Python、Go、Java、Node.js、PHP、C#、Ruby 等多种语言的示例

主要特性

1. 美观的首页 - 使用 VitePress 的 home layout，展示项目特色
2. 清晰的导航 - 顶部导航和侧边栏导航
3. 搜索功能 - 内置本地搜索
4. 响应式设计 - 支持移动端访问
5. 中文优化 - 所有界面文字都已本地化
6. 代码高亮 - 支持多种编程语言的代码高亮
7. 自动目录 - 每个页面自动生成目录

下一步建议

1. 可以在 docs/public/ 目录添加更多图片和资源
2. 可以在配置文件中自定义主题颜色
3. 可以添加更多的文档页面
4. 可以配置 GitHub Pages 或其他静态站点托管服务进行部署

部署到生产环境

GitHub Pages

1. 在 .vitepress/config.mts 中设置 base:

export default defineConfig({
  base: '/Message-Push-Nest/',
  // ...
})

2. 构建并部署:

npm run docs:build
# 将 .vitepress/dist 目录部署到 GitHub Pages

Vercel / Netlify

直接连接 GitHub 仓库，设置：

• Build Command: npm run docs:build
• Output Directory: docs/.vitepress/dist

注意事项

• 文档内容已根据 README.md 进行了合理拆分
• 保留了所有原始信息和代码示例
• 添加了更好的组织结构和导航
• 使用了 VitePress 的特性（如提示框、代码块等）