diff --git a/.config/typedoc.config.mjs b/.config/typedoc.config.mjs new file mode 100644 index 0000000..d5b4c08 --- /dev/null +++ b/.config/typedoc.config.mjs @@ -0,0 +1,16 @@ +import pkgInfo from "../package.json" assert { type: "json" } +import path from "node:path" + +const entryPoints = Object.keys(pkgInfo.exports).map(i => { + const exportEndpoint = i === "." ? "./XLinkSDK" : i + const exportEndpointFilePath = path.join("../src", exportEndpoint) + ".ts" + return exportEndpointFilePath +}) + +/** @type {Partial} */ +const config = { + entryPoints: entryPoints, + out: "../generated/docs", +} + +export default config diff --git a/.gitignore b/.gitignore index c8f1690..e1bc2eb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ node_modules/ +generated/docs/ lib/ *.tgz .envrc.*.local diff --git a/package.json b/package.json index 25ca472..103281a 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,8 @@ "scripts": { "gen:stacksContract": "rm -rf generated/smartContract && mkdir -p generated/smartContract && tsx ./scripts/generateClarityTranscoders.ts", "gen": "pnpm run gen:stacksContract", - "docs": "npx typedoc src/index.ts", + "docs": "typedoc", + "docs:watch": "typedoc --watch", "build": "pnpm run gen && rm -rf lib && tsup-node --sourcemap --dts -d lib --format cjs,esm src", "prepare": "pnpm run build", "test": "vitest --exclude lib"