frontend: Upgrade typedoc

Signed-off-by: Oleksandr Dubenko <[email protected]>
headlamp-k8s · Jul 31, 2024 · 3a12823 · 3a12823
1 parent c775040
commit 3a12823
Show file tree

Hide file tree

Showing 3 changed files with 171 additions and 76 deletions.
diff --git a/frontend/package-lock.json b/frontend/package-lock.json
diff --git a/frontend/package.json b/frontend/package.json
@@ -206,9 +206,9 @@
     "redux-mock-store": "^1.5.4",
     "resize-observer-polyfill": "^1.5.1",
     "storybook": "^7.6.7",
-    "typedoc": "0.22.10",
-    "typedoc-plugin-markdown": "3.11.14",
-    "typedoc-plugin-rename-defaults": "0.4.0",
+    "typedoc": "^0.26.5",
+    "typedoc-plugin-markdown": "^4.2.3",
+    "typedoc-plugin-rename-defaults": "^0.7.1",
     "vitest-canvas-mock": "^0.3.3",
     "vitest-websocket-mock": "^0.3.0",
     "vm-browserify": "^1.1.2"

diff --git a/frontend/tsconfig.json b/frontend/tsconfig.json
@@ -20,6 +20,7 @@
   "include": ["src"],
   "typedocOptions": {
     "out": "../docs/development/api",
+    "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-rename-defaults"],
     "entryPoints": [
       "src/lib/k8s/",
       "src/redux/reducers/reducers.tsx",
@@ -34,9 +35,14 @@
     "excludePrivate": true,
     "excludeProtected": true,
     "readme": "none",
-    "hideInPageTOC": true,
     "name": "API",
-    "indexTitle": "API Reference",
-    "entryDocument": "API.md"
+    "useCodeBlocks": "true",
+    "entryFileName": "API.md",
+    "hidePageHeader": "true",
+    "hideBreadcrumbs": "true",
+    "expandParameters": "true",
+    "parametersFormat": "table",
+    "indexFormat": "table",
+    "classPropertiesFormat": "table"
   }
 }