diff --git a/docs/typedoc.json b/docs/typedoc.json index 5ac202000..3d8541efa 100644 --- a/docs/typedoc.json +++ b/docs/typedoc.json @@ -2,11 +2,18 @@ "$schema": "https://typedoc.org/schema.json", "entryPointStrategy": "packages", "entryPoints": ["../packages/wxt"], - "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"], + "plugin": [ + "typedoc-plugin-markdown", + "typedoc-vitepress-theme", + "typedoc-plugin-frontmatter" + ], "out": "./api/reference", "githubPages": false, "excludePrivate": true, "excludeProtected": true, "excludeInternal": true, - "readme": "none" + "readme": "none", + "frontmatterGlobals": { + "editLink": false + } } diff --git a/package.json b/package.json index 53264f64a..0214dcba3 100644 --- a/package.json +++ b/package.json @@ -32,6 +32,7 @@ "simple-git-hooks": "^2.11.1", "tsx": "4.15.7", "typedoc": "^0.25.4", + "typedoc-plugin-frontmatter": "^1.1.0", "typedoc-plugin-markdown": "4.0.0-next.23", "typedoc-vitepress-theme": "1.0.0-next.3", "typescript": "^5.6.3", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index cd620fddb..2b3828b58 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -58,6 +58,9 @@ importers: typedoc: specifier: ^0.25.4 version: 0.25.4(typescript@5.6.3) + typedoc-plugin-frontmatter: + specifier: ^1.1.0 + version: 1.1.0(typedoc-plugin-markdown@4.0.0-next.23(typedoc@0.25.4(typescript@5.6.3))) typedoc-plugin-markdown: specifier: 4.0.0-next.23 version: 4.0.0-next.23(typedoc@0.25.4(typescript@5.6.3)) @@ -4682,6 +4685,11 @@ packages: typedarray@0.0.6: resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==} + typedoc-plugin-frontmatter@1.1.0: + resolution: {integrity: sha512-4PW4V2xDY2hw+fEWmg7g6FBCIWZdiEE+tzjJ5K4JhurvJ0t0Vp0IE/0nuHGGIZVtV5WxPIed+GpiH1uZrpDquQ==} + peerDependencies: + typedoc-plugin-markdown: '>=4.3.0' + typedoc-plugin-markdown@4.0.0-next.23: resolution: {integrity: sha512-bKD0LnrQxUTbuDRiJfCWYLlzyERuskWldJ5eWKKuNY38xBOyBhSN8P+vD5KxlJoAifTOm76MK58sNrl4wgOoWg==} peerDependencies: @@ -9294,6 +9302,11 @@ snapshots: typedarray@0.0.6: {} + typedoc-plugin-frontmatter@1.1.0(typedoc-plugin-markdown@4.0.0-next.23(typedoc@0.25.4(typescript@5.6.3))): + dependencies: + typedoc-plugin-markdown: 4.0.0-next.23(typedoc@0.25.4(typescript@5.6.3)) + yaml: 2.5.1 + typedoc-plugin-markdown@4.0.0-next.23(typedoc@0.25.4(typescript@5.6.3)): dependencies: typedoc: 0.25.4(typescript@5.6.3)