feat: added typedoc

andrewcourtice · Jun 27, 2022 · be348c2 · be348c2
1 parent cca4584
commit be348c2
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -38,6 +38,7 @@
         "lerna": "^5.1.4",
         "standard-changelog": "^2.0.27",
         "tsup": "^6.1.2",
+        "typedoc": "^0.23.1",
         "typescript": "^4.7.4",
         "vitest": "^0.15.2",
         "vue-eslint-parser": "^9.0.2"

diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,11 @@
+{
+    "entryPointStrategy": "packages",
+    "entryPoints": [
+        "core",
+        "packages/*",
+        "extensions/*",
+        "plugins/*"
+    ],
+    "out": "docs/src/typedoc",
+    "excludeExternals": true
+}
diff --git a/yarn.lock b/yarn.lock
@@ -6600,6 +6600,7 @@ __metadata:
     lerna: ^5.1.4
     standard-changelog: ^2.0.27
     tsup: ^6.1.2
+    typedoc: ^0.23.1
     typescript: ^4.7.4
     vitest: ^0.15.2
     vue-eslint-parser: ^9.0.2
@@ -7881,6 +7882,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"lunr@npm:^2.3.9":
+  version: 2.3.9
+  resolution: "lunr@npm:2.3.9"
+  checksum: 176719e24fcce7d3cf1baccce9dd5633cd8bdc1f41ebe6a180112e5ee99d80373fe2454f5d4624d437e5a8319698ca6837b9950566e15d2cae5f2a543a3db4b8
+  languageName: node
+  linkType: hard
+
 "magic-string@npm:^0.25.7":
   version: 0.25.9
   resolution: "magic-string@npm:0.25.9"
@@ -8010,6 +8018,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"marked@npm:^4.0.16":
+  version: 4.0.17
+  resolution: "marked@npm:4.0.17"
+  bin:
+    marked: bin/marked.js
+  checksum: 33a3c43a20b47bddaf045a59bfc7c3d41cc321931cc663ed231ca3b5b3b195fb2ac2973e687c2afd65b79539c14619baa07d19793f70130160f0af80c06d9b3a
+  languageName: node
+  linkType: hard
+
 "mdn-data@npm:2.0.14":
   version: 2.0.14
   resolution: "mdn-data@npm:2.0.14"
@@ -8136,7 +8153,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"minimatch@npm:^5.0.1":
+"minimatch@npm:^5.0.1, minimatch@npm:^5.1.0":
   version: 5.1.0
   resolution: "minimatch@npm:5.1.0"
   dependencies:
@@ -11791,6 +11808,22 @@ __metadata:
   languageName: node
   linkType: hard
 
+"typedoc@npm:^0.23.1":
+  version: 0.23.1
+  resolution: "typedoc@npm:0.23.1"
+  dependencies:
+    lunr: ^2.3.9
+    marked: ^4.0.16
+    minimatch: ^5.1.0
+    shiki: ^0.10.1
+  peerDependencies:
+    typescript: 4.6.x || 4.7.x
+  bin:
+    typedoc: bin/typedoc
+  checksum: 8622847ffff85b4ca2fa4d95e7507aafe50b155fe37d7f3f9b2721f7a80effecbca4dda682f9f81bdf1ac230cefd6e6127715398146fc00205042f25da19373a
+  languageName: node
+  linkType: hard
+
 "typescript@npm:^4.6.4, typescript@npm:^4.7.4":
   version: 4.7.4
   resolution: "typescript@npm:4.7.4"