Add GitHub Actions workflow for VitePress documentation deployment to GitHub Pages

Co-authored-by: GreenShadeZhang <[email protected]>

Author: Copilot

.github/workflows/README.md

@@ -0,0 +1,46 @@
+# GitHub Actions 工作流说明
+
+本目录包含项目的 GitHub Actions 工作流配置文件。
+
+## 工作流文件
+
+### `build.yml`
+构建和测试工作流，支持多平台（Windows、Linux、macOS）和多 .NET 版本。
+
+### `ci.yml`
+持续集成工作流，包含代码分析和安全扫描。
+
+### `release.yml`
+发布工作流（如果存在）。
+
+### `deploy-docs.yml`
+文档部署工作流，自动将 VitePress 文档网站部署到 GitHub Pages。
+
+#### 使用说明
+
+1. **自动触发**：当向 `main` 分支推送包含 `docs-website/` 目录变更的提交时自动触发
+2. **手动触发**：可在 GitHub Actions 页面手动运行
+3. **自定义域名**：如果配置了自定义域名，请：
+   - 在工作流文件中取消注释相应的环境变量设置
+   - 修改 CNAME 文件创建步骤，填入你的域名
+   - 将 `if: false` 改为 `if: true`
+
+#### 权限要求
+
+工作流需要以下权限：
+- `contents: read` - 读取仓库内容
+- `pages: write` - 写入 GitHub Pages
+- `id-token: write` - 部署到 Pages 环境
+
+#### 环境配置
+
+确保在仓库设置中启用 GitHub Pages：
+1. 进入 Settings > Pages
+2. 选择 Source 为 "GitHub Actions"
+3. 如果使用自定义域名，在 Custom domain 中配置域名
+
+## 故障排除
+
+- 如果部署失败，检查 GitHub Pages 设置
+- 确保 `docs-website/package.json` 中的依赖正确
+- 检查 VitePress 配置文件中的 base 路径设置

.github/workflows/deploy-docs.yml

@@ -0,0 +1,75 @@
+name: Deploy Documentation to GitHub Pages
+
+on:
+  # 在main分支推送时触发
+  push:
+    branches: [main]
+    paths:
+      - 'docs-website/**'
+      - '.github/workflows/deploy-docs.yml'
+
+  # 允许手动触发
+  workflow_dispatch:
+
+# 设置GITHUB_TOKEN权限以允许部署到GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# 只允许一个并发部署，跳过正在运行的部署之间的运行队列
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # 需要完整历史记录以获取最后修改时间
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: npm
+          cache-dependency-path: docs-website/package-lock.json
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: docs-website
+
+      - name: Build with VitePress
+        run: npm run build
+        working-directory: docs-website
+        env:
+          # 如果使用自定义域名，取消注释下一行
+          # CUSTOM_DOMAIN: true
+
+      - name: Add CNAME file (if using custom domain)
+        run: |
+          # 如果使用自定义域名，取消注释并修改下一行的域名
+          # echo "your-custom-domain.com" > docs-website-dist/CNAME
+        if: false  # 将此改为 true 如果使用自定义域名
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs-website-dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -364,4 +364,5 @@ FodyWeavers.xsd
 
 # VitePress build and cache directories
 docs-website/.vitepress/dist/
-docs-website/.vitepress/cache/
+docs-website/.vitepress/cache/
+docs-website-dist/