Improve frontend API Reference

wuespace · Dec 15, 2023 · abf28c6 · abf28c6
1 parent 5a7bfd4
commit abf28c6
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 40 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -68,6 +68,8 @@ markdown_extensions:
   - pymdownx.inlinehilite
   - pymdownx.snippets
   - pymdownx.details
+  - pymdownx.smartsymbols
+  - pymdownx.escapeall # support for backslash escapes in typedoc output
   - pymdownx.tabbed:
       alternate_style: true
   - pymdownx.superfences:

diff --git a/frontend-react/package.json b/frontend-react/package.json
@@ -93,7 +93,7 @@
 		"react": "^18.2.0",
 		"sass": "^1.69.5",
 		"typedoc": "^0.25.4",
-		"typedoc-plugin-markdown": "3.16.0",
+		"typedoc-plugin-markdown": "^4.0.0-next.36",
 		"typedoc-plugin-mdn-links": "^3.1.6",
 		"typedoc-plugin-zod": "^1.1.0",
 		"typescript": "^5.2.2",

diff --git a/frontend-react/pnpm-lock.yaml b/frontend-react/pnpm-lock.yaml
diff --git a/frontend-react/typedoc.json b/frontend-react/typedoc.json
@@ -17,5 +17,9 @@
 	"hideGenerator": true,
 	"disableSources": true,
 	"hideInPageTOC": true,
+	"outputFileStrategy": "members",
+	"hidePageTitle": true,
+	"hidePageHeader": true,
+	"indexPageTitle": "API Reference",
 	"readme": "none"
 }