feat: support vitepress deployment on github pages

Author: YumengBao

.github/workflow/deploy-docs.yaml

@@ -0,0 +1,56 @@
+# 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程
+#
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    branches:
+      - main
+      - feat/docs
+    paths:
+      - 'docs/**'
+      - '.github/workflows/deploy-docs.yml'
+
+  # 允许你从 Actions 选项卡手动运行此工作流程
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: '22'
+
+      - name: Install dependencies
+        run: |
+          cd docs
+          echo "Check current directory"
+          pwd
+          npm ci
+
+      - name: Build with VitePress
+        run: |
+          cd docs
+          echo "Check current directory"
+          pwd
+          npm run docs:build
+          
+      - name: Deploy to feat/deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.REPO_TOKEN }}
+          publish_dir: docs/.vitepress/dist
+          publish_branch: feat/deploy
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          commit_message: 'Deploy docs to feat/deploy'

.gitignore

@@ -167,8 +167,7 @@ cython_debug/
 uv.lock
 
 # VitePress related files (security concern - keep Markdown docs in repo)
-docs/package.json
-docs/package-lock.json
+
 docs/node_modules/
 
 # local test files

docs/.gitignore

@@ -1,5 +1,3 @@
 node_modules
 .vitepress/cache
 .vitepress/dist
-package-lock.json
-package.json

docs/.vitepress/.vitepress/cache/deps/_metadata.json

@@ -0,0 +1,31 @@
+{
+  "hash": "bd82e864",
+  "configHash": "82d8e97e",
+  "lockfileHash": "af04ab03",
+  "browserHash": "a726e73b",
+  "optimized": {
+    "vue": {
+      "src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
+      "file": "vue.js",
+      "fileHash": "4235b90c",
+      "needsInterop": false
+    },
+    "vitepress > @vue/devtools-api": {
+      "src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
+      "file": "vitepress___@vue_devtools-api.js",
+      "fileHash": "923481af",
+      "needsInterop": false
+    },
+    "vitepress > @vueuse/core": {
+      "src": "../../../../node_modules/@vueuse/core/dist/index.js",
+      "file": "vitepress___@vueuse_core.js",
+      "fileHash": "ee4e3675",
+      "needsInterop": false
+    }
+  },
+  "chunks": {
+    "chunk-VNBOKC53": {
+      "file": "chunk-VNBOKC53.js"
+    }
+  }
+}