TELESTION-447 Add API reference

Add Frontend React API Reference
wuespace · Dec 15, 2023 · 50de6b7 · 50de6b7
1 parent 75c3fe1
commit 50de6b7
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 7 deletions.
diff --git a/docs/docs/Frontend Development/.gitignore b/docs/docs/Frontend Development/.gitignore
@@ -0,0 +1,2 @@
+# generated by the /frontend-react's "docs" script
+api
diff --git a/docs/docs/Frontend Development/.pages b/docs/docs/Frontend Development/.pages
@@ -1,4 +1,6 @@
 nav:
     - index.md
+    - concepts.md
+    - "API Reference": api
     - ...
-#    - "API Reference ↗️": https://github.com
+    #- "API Reference ↗️": https://github.com
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.17.1",
+		"typedoc-plugin-markdown": "3.16.0",
 		"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
@@ -5,13 +5,17 @@
 		"typedoc-plugin-mdn-links",
 		"typedoc-plugin-zod"
 	],
+	"titleLink": "/",
 	"entryPoints": ["./src/lib/index.ts"],
-	"out": "doc",
+	"out": "../docs/docs/Frontend Development/api",
 	"githubPages": false,
 	"validation": {
 		"notDocumented": true,
 		"invalidLink": true,
 		"notExported": true
 	},
+	"hideGenerator": true,
+	"disableSources": true,
+	"hideInPageTOC": true,
 	"readme": "none"
 }