feat: 添加文档站

.github/workflows/deploy-docs.yml

@@ -0,0 +1,59 @@
+name: 部署文档
+
+on:
+  push:
+    paths:
+      - '.github/workflows/deploy-docs.yml'
+      - 'docs/**'
+  pull_request:
+    paths:
+      - '.github/workflows/deploy-docs.yml'
+      - 'docs/**'
+
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          # 如果你文档需要 Git 子模块，取消注释下一行
+          submodules: true
+
+      - name: 设置 pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 8
+
+
+      - name: 设置 Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+
+      - name: 安装依赖
+        run: |
+          cd docs
+          corepack enable
+          pnpm install --frozen-lockfile
+
+      - name: 构建文档
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          cd docs
+          pnpm run docs:build
+          > src/.vuepress/dist/.nojekyll
+
+      - name: 部署文档
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          # 部署文档
+          branch: gh-pages
+          folder: docs/src/.vuepress/dist

.gitignore

@@ -22,4 +22,6 @@
 *.scvd
 *.usb.tmp
 build
-.idea
+.idea
+
+.DS_Store

docs/.gitignore

@@ -0,0 +1,5 @@
+
+node_modules/
+src/.vuepress/.cache/
+src/.vuepress/.temp/
+src/.vuepress/dist/

docs/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "cherrydap",
+  "description": "CherryDAP's documentation",
+  "version": "1.0.0",
+  "license": "CC-BY-SA 4.0",
+  "type": "module",
+  "scripts": {
+    "docs:build": "vuepress-vite build src",
+    "docs:clean-dev": "vuepress-vite dev src --clean-cache",
+    "docs:dev": "vuepress-vite dev src",
+    "docs:update-package": "pnpm dlx vp-update"
+  },
+  "devDependencies": {
+    "@vuepress/bundler-vite": "2.0.0-rc.14",
+    "vue": "^3.4.31",
+    "vuepress": "2.0.0-rc.14",
+    "vuepress-theme-hope": "2.0.0-rc.52"
+  }
+}