diff --git a/docs/docs/Frontend Development/.gitignore b/docs/docs/Frontend Development/.gitignore new file mode 100644 index 00000000..d555b48a --- /dev/null +++ b/docs/docs/Frontend Development/.gitignore @@ -0,0 +1,2 @@ +# generated by the /frontend-react's "docs" script +api \ No newline at end of file diff --git a/docs/docs/Frontend Development/.pages b/docs/docs/Frontend Development/.pages index d4c03a54..965b2434 100644 --- 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 index ec27fb6c..4a0ae698 100644 --- 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 index f373d065..bf9476bf 100644 --- a/frontend-react/pnpm-lock.yaml +++ b/frontend-react/pnpm-lock.yaml @@ -89,8 +89,8 @@ devDependencies: specifier: ^0.25.4 version: 0.25.4(typescript@5.2.2) typedoc-plugin-markdown: - specifier: ^3.17.1 - version: 3.17.1(typedoc@0.25.4) + specifier: 3.16.0 + version: 3.16.0(typedoc@0.25.4) typedoc-plugin-mdn-links: specifier: ^3.1.6 version: 3.1.6(typedoc@0.25.4) @@ -3773,8 +3773,8 @@ packages: is-typed-array: 1.1.12 dev: true - /typedoc-plugin-markdown@3.17.1(typedoc@0.25.4): - resolution: {integrity: sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==} + /typedoc-plugin-markdown@3.16.0(typedoc@0.25.4): + resolution: {integrity: sha512-eeiC78fDNGFwemPIHiwRC+mEC7W5jwt3fceUev2gJ2nFnXpVHo8eRrpC9BLWZDee6ehnz/sPmNjizbXwpfaTBw==} peerDependencies: typedoc: '>=0.24.0' dependencies: diff --git a/frontend-react/typedoc.json b/frontend-react/typedoc.json index 6a97a61a..9257cde9 100644 --- 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" }