Merge pull request #3 from Awesome-Embedded-Learning-Studio/feat/migrate_to_vitepress

feat: migrate to vitepress

Author: Charliechen114514

.github/workflows/deploy.yml

@@ -1,51 +1,42 @@
-# 工作流名称
-name: 自动部署 MkDocs
+name: Deploy VitePress
 
-# 触发条件：推送到 main 分支
 on:
   push:
     branches:
       - main
-  
-  # 允许手动触发
   workflow_dispatch:
 
-# 设置权限
 permissions:
-  contents: write  # 允许推送到 gh-pages 分支
+  contents: write
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
-    
+
     steps:
-      # 1. 检出代码
-      - name: 检出仓库
+      - name: Checkout
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0  # 获取完整历史，显示文章修改时间
-      
-      # 2. 设置 Python
-      - name: 设置 Python
-        uses: actions/setup-python@v5
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
         with:
-          python-version: "3.11"
-          # cache: 'pip'  # 缓存依赖，加速构建
-      
-      # 3. 安装依赖
-      - name: 安装依赖
-        run: |
-          pip install mkdocs-material
-          pip install mkdocs-awesome-pages-plugin
-          pip install mkdocs-git-revision-date-localized-plugin
-      
-      # 4. 构建网站
-      - name: 构建网站
-        run: mkdocs build --clean
-      
-      # 5. 自动部署到 gh-pages 分支（这一步会自动触发 GitHub Pages）
-      - name: 部署到 GitHub Pages
+          version: 10
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build
+        run: pnpm build
+
+      - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v4
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}  # GitHub 自动提供的 token
-          publish_dir: ./site  # MkDocs 构建输出目录
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site/.vitepress/dist

.gitignore

@@ -10,4 +10,11 @@ build/
 
 # IDE / tooling cache
 .cache/
-**/.cache/
+**/.cache/
+
+# VitePress
+node_modules/
+site/.vitepress/dist/
+site/.vitepress/cache/
+site/.vitepress/.build-cache/
+site/.vitepress/.build-tmp/

mkdocs.yml

@@ -0,0 +1,26 @@
+{
+  "name": "awesomeqt-vitepress",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vitepress dev site",
+    "build": "NODE_OPTIONS='--disable-warning=DEP0205' pnpm exec tsx scripts/build.ts",
+    "build:single": "vitepress build site",
+    "preview": "vitepress preview site"
+  },
+  "devDependencies": {
+    "@types/node": "^25.6.2",
+    "tsx": "^4.21.0",
+    "vitepress": "^1.6.4",
+    "vue": "^3.5.34"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild"
+    ]
+  },
+  "dependencies": {
+    "minisearch": "^7.2.0"
+  }
+}