diff --git a/package.json b/package.json index 6c46c54..742a384 100644 --- a/package.json +++ b/package.json @@ -72,6 +72,7 @@ "ts-jest": "^27.0.3", "ts-node": "^10.8.1", "typedoc": "^0.27.9", + "typedoc-plugin-markdown": "^4.5.0", "typescript": "^5.8.2" }, "peerDependencies": { diff --git a/typedoc.json b/typedoc.json index 5c7b1d1..2aa2976 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,8 +1,13 @@ { - "entryPoints": ["./src/index.ts"], - "excludePrivate": true, - "excludeProtected": true, - "excludeExternals": true, - "includeVersion": false, - "out": "docs" + "entryPoints": ["src/index.ts"], + "out": "docs/api", + "plugin": ["typedoc-plugin-markdown"], + "excludePrivate": true, + "excludeProtected": true, + "excludeExternals": true, + "includeVersion": false, + "hideBreadcrumbs": true, + "hidePageHeader": true, + "entryFileName": "index.md", + "readme": "none" } diff --git a/yarn.lock b/yarn.lock index 47d7a09..9388c9b 100644 --- a/yarn.lock +++ b/yarn.lock @@ -7237,6 +7237,11 @@ typedarray-to-buffer@^3.1.5: dependencies: is-typedarray "^1.0.0" +typedoc-plugin-markdown@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.5.0.tgz#83a35d4bfd526fece39d3121f32651cac500d3ec" + integrity sha512-SZ3Nhkl8WE46W2/9OrjHIkXeSi4ZuceQeGxw2kGHyaaooRHYiiHlOWJx6SM0WKjqRUTfhz9T7wSwm3zwPEZndA== + typedoc@^0.27.9: version "0.27.9" resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.27.9.tgz#5e0a7bc32bfc7bd0b70a353f4f1d5cba3d667c46"