docs(editor): scaffolding docs generator (#10925)

2025-03-17 12:51:08 +00:00
parent 363c9799f3
commit 1d04438049
59 changed files with 2101 additions and 9 deletions
--- a/blocksuite/docs/typedoc.json
+++ b/blocksuite/docs/typedoc.json
@@ -0,0 +1,26 @@
+{
+  "entryPoints": ["../framework/store", "../framework/block-std"],
+  "packageOptions": {
+    "readme": "none",
+    "categorizeByGroup": false,
+    "includeVersion": false,
+    "excludeNotDocumented": true,
+    "excludeInternal": true,
+    "excludePrivate": true,
+    "excludeProtected": true,
+    "excludeExternals": true,
+    "externalPattern": ["node_modules/**/*"],
+    "disableSources": true
+  },
+  "readme": "none",
+  "plugin": ["typedoc-plugin-markdown"],
+  "out": "./api",
+  "entryPointStrategy": "packages",
+  "includeVersion": false,
+  "logLevel": "Error",
+  "name": "BlockSuite API Documentation",
+  "navigation": {
+    "includeCategories": true
+  },
+  "sort": ["source-order"]
+}