Skip to content

Commit

Permalink
🚧📝 Startup typedoc setup for auto SDK documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
KONFeature committed Dec 12, 2024
1 parent 2604187 commit 4e0fb11
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 3 deletions.
Binary file modified bun.lockb
Binary file not shown.
8 changes: 5 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,16 @@
"@changesets/changelog-git": "^0.2.0",
"@changesets/changelog-github": "^0.5.0",
"@changesets/cli": "^2.27.7",
"@pulumi/aws": "^6.60.0",
"@pulumi/pulumi": "^3.141.0",
"@types/node": "^22.0.0",
"knip": "^5.27.0",
"npm-check-updates": "^16.14.20",
"rimraf": "^6.0.1",
"sst": "3.3.28",
"typescript": "^5.6.2",
"@pulumi/aws": "^6.60.0",
"@pulumi/pulumi": "^3.141.0"
"typedoc": "^0.27.4",
"typedoc-plugin-markdown": "^4.3.2",
"typescript": "^5.6.2"
},
"workspaces": [
"packages/*",
Expand Down
20 changes: 20 additions & 0 deletions typedoc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/** @type {Partial<import("typedoc").TypeDocOptions>} */
const config = {
plugin: ["typedoc-plugin-markdown"],
entryPoints: ["sdk/*"],
entryPointStrategy: "packages",
packageOptions: {
entryPoints: [
// top level entry points,
"src/index.ts",
"src/components.ts",
"src/bundle.ts",
// Core SDK custom entry points
"src/actions/index.ts",
"src/interactions/index.ts",
],
},
out: "./docs-tmp",
};

export default config;

0 comments on commit 4e0fb11

Please sign in to comment.