🚗 docs: refactor

.github/workflows/algolia.yml

@@ -0,0 +1,24 @@
+name: Deploy
+on:
+  push:
+    branches:
+      - master
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+  algolia:
+    needs: deploy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Get the content of algolia.json as config
+        id: algolia_config
+        run: echo "::set-output name=config::$(cat algolia.json | jq -r tostring)"
+      - name: Push indices to Algolia
+        uses: signcl/docsearch-scraper-action@master
+        env:
+          APPLICATION_ID: ${{ secrets.APPLICATION_ID }}
+          API_KEY: ${{ secrets.API_KEY }}
+          CONFIG: ${{ steps.algolia_config.outputs.config }}

.github/workflows/ci.yml

@@ -43,14 +43,5 @@ jobs:
       - name: Build Lib
         run: |
           pnpm build
-      - name: Build Docs plugin
-        run: |
-          cd packages/vitepress/vitepress-demo-block
-          pnpm run build
-      - name: Build Docs
-        run: |
-          cd packages/hooks
-          pnpm run initial
-          pnpm run docs:build
         env:
           CI: true

.github/workflows/deploy.yml

@@ -0,0 +1,82 @@
+# 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # 在针对 `main` 分支的推送上运行。如果你
+  # 使用 `master` 分支作为默认分支，请将其更改为 `master`
+  push:
+    branches: [master]
+
+  # 允许你从 Actions 选项卡手动运行此工作流程
+  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 # 如果未启用 lastUpdated，则不需要
+      # - uses: pnpm/action-setup@v3 # 如果使用 pnpm，请取消此区域注释
+      #   with:
+      #     version: 9
+      # - uses: oven-sh/setup-bun@v1 # 如果使用 Bun，请取消注释
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        run: |
+          echo "pnpm_cache_dir=$(pnpm store path)" >> "$GITHUB_OUTPUT"
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: pnpm # 或 pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: pnpm install # 或 pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: pnpm docs:build # 或 pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # 部署工作
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -3,7 +3,9 @@ dist
 .DS_Store
 .cache
 .temp
+cache
 coverage
+.docs
 
 
 # lock

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx --no-install commitlint --edit "$1"
+# npx --no-install commitlint --edit "$1"

.markdownlint.json

@@ -1,6 +1,6 @@
 {
   "no-inline-html": {
-    "allowed_elements": ["ul", "li", "div", "img", "a", "br", "script", "Badge", "Home"]
+    "allowed_elements": ["ul", "li", "div", "img", "a", "br", "script", "Badge", "Home","demo"]
   },
   "MD013": false,
   "MD041": false

.npmrc

@@ -0,0 +1,3 @@
+shamefully-hoist=true
+auto-install-peers=true
+strict-peer-dependencies=false

.vscode/settings.json

@@ -0,0 +1 @@
+{}

algolia.json

@@ -0,0 +1,27 @@
+{
+	"index_name": "vue-hooks-plus-search",
+	"start_urls": ["https://inhiblabcore.github.io/vue-hooks-plus"],
+	"rateLimit": 8,
+	"maxDepth": 10,
+	"selectors": {
+		"lvl0": {
+			"selector": "",
+			"defaultValue": "Documentation"
+		},
+		"lvl1": ".content h1",
+		"lvl2": ".content h2",
+		"lvl3": ".content h3",
+		"lvl4": ".content h4",
+		"lvl5": ".content h5",
+		"content": ".content p, .content li",
+    "lang": {
+      "selector": "/html/@lang",
+      "type": "xpath",
+      "global": true,
+      "default_value": "zh-CN"
+    }
+  },
+  "custom_settings": {
+    "attributesForFaceting": ["lang"]
+	}
+}