docs(refactor): organize the pkgs and fix some issues (#702)

* docs: rebuild docs * chore: fix eslint * ci: add docs build test * update test-docs.yml * fix script * add netlify.toml * fix docs:patch --------- Co-authored-by: qwqcode <[email protected]>
ArtalkJS · Dec 19, 2023 · 91228a9 · 91228a9
1 parent 7a0a9db
commit 91228a9
Show file tree

Hide file tree

Showing 123 changed files with 7,822 additions and 9,744 deletions.
diff --git a/.github/workflows/docs-cn.yml b/.github/workflows/docs-cn.yml
@@ -13,50 +13,32 @@ jobs:
 
     runs-on: ubuntu-latest
 
-    defaults:
-      run:
-        # set for building docs
-        working-directory: ./docs
-
     steps:
-    # - name: Wait for other docs build to succeed
-    #   uses: lewagon/[email protected]
-    #   with:
-    #     running-workflow-name: 'Docs CN Mirror Deploy'
-    #     check-name: 'Build Docs'
-    #     ref: ${{ github.ref }}
-    #     repo-token: ${{ secrets.GITHUB_TOKEN }}
-    #     allowed-conclusions: success,skipped,cancelled
-    #     wait-interval: 10
-
-    - name: Checkout
-      uses: actions/checkout@v3
-
-    - name: Use pnpm
-      uses: pnpm/action-setup@v2
-      with:
-        version: 8
-
-    - name: Setup node
-      uses: actions/setup-node@v3
-      with:
-        node-version: 18.x
-        registry-url: https://registry.npmjs.org/
-        cache: 'pnpm'
-
-    - name: Install dependencies
-      run: pnpm install
-
-    - name: Build Docs
-      run: pnpm docs:build
-
-    - name: Deploy
-      uses: TencentCloud/cos-action@v1
-      with:
-        secret_id: ${{ secrets.TENCENT_CLOUD_SECRET_ID }}
-        secret_key: ${{ secrets.TENCENT_CLOUD_SECRET_KEY }}
-        cos_bucket: ${{ secrets.DOCS_CN_COS_BUCKET }}
-        cos_region: ${{ secrets.DOCS_CN_COS_REGION }}
-        local_path: .vitepress/dist/
-        remote_path: /
-        clean: true
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Use pnpm
+        uses: pnpm/action-setup@v2
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build Docs
+        run: pnpm docs:build
+
+      - name: Deploy
+        uses: TencentCloud/cos-action@v1
+        with:
+          secret_id: ${{ secrets.TENCENT_CLOUD_SECRET_ID }}
+          secret_key: ${{ secrets.TENCENT_CLOUD_SECRET_KEY }}
+          cos_bucket: ${{ secrets.DOCS_CN_COS_BUCKET }}
+          cos_region: ${{ secrets.DOCS_CN_COS_REGION }}
+          local_path: .vitepress/dist/
+          remote_path: /
+          clean: true
diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml
@@ -0,0 +1,32 @@
+name: Test Docs
+
+on:
+  pull_request:
+    paths:
+      - "docs/**"
+  push:
+    paths:
+      - "docs/**"
+
+jobs:
+  test_docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Use pnpm
+        uses: pnpm/action-setup@v2
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build Docs
+        run: pnpm docs:build
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/.npmrc b/docs/.npmrc
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
diff --git a/docs/docs/.gitignore b/docs/docs/.gitignore
@@ -0,0 +1,2 @@
+.vitepress/dist/**
+.vitepress/cache/**