From 9ffbbc5f38e933430a4e5ec78f6eb70df88d6298 Mon Sep 17 00:00:00 2001
From: KaiKai <kaikai_miniworld@outlook.com>
Date: Tue, 30 Jan 2024 22:22:31 +0800
Subject: [PATCH] =?UTF-8?q?ci:=20PR=20=E6=A3=80=E6=9F=A5=E6=B7=BB=E5=8A=A0?=
 =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=9E=84=E5=BB=BA=E6=B5=8B=E8=AF=95=20(#103)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .github/workflows/check.yml | 24 ++++++++++++++----------
 typedoc.json                |  1 +
 2 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
index 97be452..2a5184d 100644
--- a/.github/workflows/check.yml
+++ b/.github/workflows/check.yml
@@ -15,11 +15,6 @@ jobs:
       - uses: pnpm/action-setup@v2
         with:
           version: 8
-      - uses: actions/cache@v4
-        with:
-          path: node_modules
-          key: dependencies
-          restore-keys: dependencies
       - run: pnpm install
       - run: pnpm lint
 
@@ -34,10 +29,19 @@ jobs:
       - uses: pnpm/action-setup@v2
         with:
           version: 8
-      - uses: actions/cache@v4
-        with:
-          path: node_modules
-          key: dependencies
-          restore-keys: dependencies
       - run: pnpm install
       - run: pnpm test
+
+  docs:
+    name: 文档构建测试
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+      - run: pnpm install
+      - run: pnpm docs:build
diff --git a/typedoc.json b/typedoc.json
index 363ca99..ef7180a 100644
--- a/typedoc.json
+++ b/typedoc.json
@@ -2,6 +2,7 @@
   "entryPoints": [
     "src/index.ts"
   ],
+  "readme": "docs/api/index.md",
   "out": "docs/api",
   "cleanOutputDir": false,
   "jsDocCompatibility": true,