docs: add typedoc for project

dromara · May 8, 2024 · 3d2b1d9 · 3d2b1d9
1 parent 6321727
commit 3d2b1d9
Show file tree

Hide file tree

Showing 24 changed files with 105 additions and 2 deletions.
diff --git a/mods/mod-chart/README.md b/mods/mod-chart/README.md
diff --git a/mods/mod-chart/typedoc.json b/mods/mod-chart/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}
diff --git a/mods/mod-geometry/README.md b/mods/mod-geometry/README.md
diff --git a/mods/mod-geometry/typedoc.json b/mods/mod-geometry/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}
diff --git a/mods/mod-markdown/README.md b/mods/mod-markdown/README.md
diff --git a/mods/mod-markdown/typedoc.json b/mods/mod-markdown/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}
diff --git a/mods/mod-math/README.md b/mods/mod-math/README.md
diff --git a/mods/mod-math/typedoc.json b/mods/mod-math/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}
diff --git a/package.json b/package.json
@@ -21,6 +21,7 @@
     "docs:preview": "pnpm --filter=@newcar/docs docs:preview",
     "play:dev": "pnpm --filter=@newcar/playground dev",
     "play:build": "pnpm --filter=@newcar/playground build",
+    "api:generate": "pnpm typedoc",
     "dep": "taze -r",
     "dep:write": "taze -rw",
     "prepare": "simple-git-hooks"
@@ -36,6 +37,7 @@
     "rimraf": "^3.0.2",
     "simple-git-hooks": "^2.11.1",
     "taze": "^0.13.8",
+    "typedoc": "^0.25.13",
     "typescript": "^5.4.5",
     "vite": "^5.2.11"
   },

diff --git a/packages/basic/README.md b/packages/basic/README.md
diff --git a/packages/basic/typedoc.json b/packages/basic/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}
diff --git a/packages/core/README.md b/packages/core/README.md
diff --git a/packages/core/typedoc.json b/packages/core/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}
diff --git a/packages/newcar/README.md b/packages/newcar/README.md
diff --git a/packages/newcar/typedoc.json b/packages/newcar/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}
diff --git a/packages/recorder/README.md b/packages/recorder/README.md
diff --git a/packages/recorder/typedoc.json b/packages/recorder/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}
diff --git a/packages/utils/README.md b/packages/utils/README.md
diff --git a/packages/utils/typedoc.json b/packages/utils/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}
diff --git a/packages/vue/src/index.ts b/packages/vue/src/index.ts
@@ -1,4 +1,4 @@
-import CarCanvas from './components/CarCanvas.vue'
+// import CarCanvas from './components/CarCanvas.vue'
 // export * from './hooks/useCarApp'
 export { newcar } from './plugin'
-export { CarCanvas }
+// export { CarCanvas }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tsconfig.json b/tsconfig.json
@@ -24,6 +24,7 @@
   "include": [
     "packages/**/*.ts",
     "examples/**/*.ts",
+    "mods/**/*.ts",
     "**/shims.d.ts",
     "test"
   ]

diff --git a/typedoc.base.json b/typedoc.base.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": false
+}
diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,8 @@
+{
+  "entryPoints": ["packages/*", "mods/*"],
+  "exclude": ["packages/vue", "mods/mod-ui"],
+  "name": "Newcar API References",
+  "entryPointStrategy": "packages",
+  "includeVersion": false,
+  "out": "./docs/apis"
+}