refactorize: refactor the embedbox

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 --frozen-lockfile
+
+      - 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

@@ -0,0 +1,10 @@
+.claude/
+
+node_modules/
+site/.vitepress/dist/
+site/.vitepress/cache/
+site/.vitepress/.build-cache/
+site/.vitepress/.build-tmp/
+*.tgz
+.pnpm-store/
+

README.md

@@ -1,18 +1,32 @@
-# Tutorial_EmbeddedCommonTools
-
-本教程创建于: 2025-12-09
-作者: Charliechen114514
-联系方式: 725610365@qq.com
-
-> 本项目隶属于组织[Awesome-Embedded-Learning-Studio](https://github.com/Awesome-Embedded-Learning-Studio)的文档教程
-
-## 快速说明
-
-> codes_and_assets下放置着本教程所有的代码, 或硬件电路图或者是PCB文件等
-> 具体的细节，请到[具体的说明步骤🖱](./codes_and_assets/instractions.md)
-> tutorial下放置着教程的Markdown文件, 您可以使用其他Markdown浏览器阅读这些教程
-> 您如果不知道从何开始，请到[从这里开始!🖱](./tutorial/index.md)查看！
-
-## 这是什么？
-
-## 快速目录
+# EmbedBox
+
+> 嵌入式开发通用工具链教程——不管走哪条嵌入式航线，都要先会用的工具：终端 / Git / Markdown / GCC / Make / CMake / GDB / 交叉编译 / 串口 / Docker / QEMU。
+
+本教程创建于 2025-12-09 · 作者 Charliechen114514 · 联系方式 725610365@qq.com
+
+本项目隶属于组织 [Awesome-Embedded-Learning-Studio](https://github.com/Awesome-Embedded-Learning-Studio) 的文档教程体系。
+
+## 这是什么？
+
+EmbedBox 是面向嵌入式开发者的「公共语言」入门坡道：在进入 AwesomeQt / ModernCPP / PenguinLab / 各 forge 之前，先把终端、Git、Markdown、编译链、CMake、GDB、交叉编译、串口这些通用工具学会。它只负责把工具教透，不替中心站 [Awesome-Embedded](https://github.com/Awesome-Embedded-Learning-Studio/Awesome-Embedded) 做导航。
+
+## 快速目录
+
+- [WSL2 + Linux + VS Code 远程开发](./tutorial/WSL/wsl.md)
+- [Markdown 零基础入门](./tutorial/markdown/markdown.md)
+- [Git 团队协作完全入门指南](./tutorial/git/index.md)（分 7 篇）
+
+## 本地预览 / 构建
+
+站点引擎为 [VitePress](https://vitepress.dev)，需要 Node 22 + pnpm 10：
+
+```bash
+pnpm install        # 安装依赖
+pnpm dev            # 本地预览（默认 http://localhost:5173/EmbedBox/）
+pnpm build          # 构建到 site/.vitepress/dist
+pnpm preview        # 预览构建产物
+```
+
+教程正文 Markdown 在 [`tutorial/`](./tutorial/index.md)；配套的示例代码 / 硬件电路图 / PCB 等资产放在 [`examples/`](./examples/instructions.md)，规则见该目录说明。
+
+推送到 `main` 分支会自动经 GitHub Actions 构建并部署到 GitHub Pages。

codes_and_assets/instractions.md

@@ -0,0 +1,16 @@
+# examples — 配套资产说明
+
+本目录存放教程正文中引用的配套资产：示例代码、硬件电路图、PCB 文件、数据手册片段等。
+
+## 命名约定
+
+- 一个教程章节对应的资产，放在以该章命名的子目录里（如 `git/`、`wsl/`）。
+- 文件名用英文小写 + 连字符（`kebab-case`），避免中文 / 空格——与站点「目录全英文」约定一致。
+- 代码文件带语言后缀（`.c`、`.py`、`.dts`）；图片用 `.png` / `.svg`。
+
+## 与教程正文的关系
+
+- 正文 Markdown 在 `tutorial/`，通过相对路径引用本目录的资产。
+- 本目录的文件**不**进 VitePress 的 `srcDir`（不会被渲染成页面），只作为被引用的静态资源。
+
+> 本目录原名 `codes_and_assets/`，已改名 `examples/` 并修正文件名拼写（原 `instractions.md` → `instructions.md`）。

examples/instructions.md

@@ -0,0 +1,20 @@
+{
+  "name": "embedbox-docs",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vitepress dev site",
+    "build": "vitepress build site",
+    "preview": "vitepress preview site"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.0",
+    "tsx": "^4.21.0",
+    "vitepress": "^1.6.4",
+    "vue": "^3.5.34"
+  },
+  "dependencies": {
+    "minisearch": "^7.2.0"
+  }
+}