{"_id":"@vendure-io/docs-generator","_rev":"2-91a450fadfe83330fb73740aa548f785","name":"@vendure-io/docs-generator","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@vendure-io/docs-generator","version":"0.1.0","keywords":["vendure","documentation","docs","typescript","api-reference","codegen"],"license":"MIT","_id":"@vendure-io/docs-generator@0.1.0","maintainers":[{"name":"dlhck","email":"d.hoeck@elevantiq.com"}],"homepage":"https://github.com/vendurehq/vendure-io#readme","bugs":{"url":"https://github.com/vendurehq/vendure-io/issues"},"dist":{"shasum":"dde7fa24b70ff4c535e5a943b09a118aeddc54bb","tarball":"https://registry.npmjs.org/@vendure-io/docs-generator/-/docs-generator-0.1.0.tgz","fileCount":16,"integrity":"sha512-31+V0pW5V4cWzJTJhRPBasXpnUn3CH7Xg5Hstc6cbA3dpQ3RjpQHTr3WtvvojPJL9rZM8En6A92SRoKETqjXdA==","signatures":[{"sig":"MEUCIQDcArVw6igV2eNRD4p+eAFIX0OyUa6lOHYaEyiUDEm5WQIgbLXSQkfYb+34+P1kAd/PMEUj196mtjqA9LP0yZbRZq8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":58602},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"require":{"types":"./dist/index.d.ts","default":"./dist/index.cjs"}}},"gitHead":"3bc715511da184d27aec999abd217869f666e89d","private":false,"scripts":{"dev":"vite build --watch","lint":"biome check .","test":"vitest run","build":"vite build","test:unit":"vitest run --coverage --coverage.reporter=text --coverage.reporter=json-summary --passWithNoTests","test:watch":"vitest","check-types":"tsc --noEmit","publish:local":"bun run build && npm publish --registry http://localhost:4873"},"_npmUser":{"name":"dlhck","email":"d.hoeck@elevantiq.com"},"repository":{"url":"git+https://github.com/vendurehq/vendure-io.git","type":"git","directory":"libs/docs-generator"},"_npmVersion":"10.9.2","description":"TypeScript API reference docs generator for Vendure packages","directories":{},"_nodeVersion":"22.13.1","dependencies":{"fs-extra":"^11.0.0","klaw-sync":"^6.0.0","typescript":"^5.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^7.0.0","vitest":"catalog:","@types/fs-extra":"^11.0.4","vite-plugin-dts":"^4.5.4","@types/klaw-sync":"^6.0.5","@vitest/coverage-v8":"catalog:"},"_npmOperationalInternal":{"tmp":"tmp/docs-generator_0.1.0_1775203987851_0.7038990178668771","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@vendure-io/docs-generator","version":"0.1.1","description":"TypeScript API reference docs generator for Vendure packages","private":false,"publishConfig":{"access":"public"},"type":"module","main":"./dist/index.cjs","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"require":{"types":"./dist/index.d.ts","default":"./dist/index.cjs"}}},"scripts":{"build":"vite build","dev":"vite build --watch","lint":"biome check .","check-types":"tsc --noEmit","test":"vitest run","test:unit":"vitest run --coverage --coverage.reporter=text --coverage.reporter=json-summary --passWithNoTests","test:watch":"vitest","publish:local":"bun run build && npm publish --registry http://localhost:4873"},"dependencies":{"fs-extra":"^11.0.0","klaw-sync":"^6.0.0","typescript":"^5.0.0"},"devDependencies":{"@types/fs-extra":"^11.0.4","@types/klaw-sync":"^6.0.5","@vitest/coverage-v8":"catalog:","vite":"^7.0.0","vite-plugin-dts":"^4.5.4","vitest":"catalog:"},"keywords":["vendure","documentation","docs","typescript","api-reference","codegen"],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/vendurehq/vendure-io.git","directory":"libs/docs-generator"},"gitHead":"ae104bd9c6139047b399580cd79ebeb197817d09","_id":"@vendure-io/docs-generator@0.1.1","bugs":{"url":"https://github.com/vendurehq/vendure-io/issues"},"homepage":"https://github.com/vendurehq/vendure-io#readme","_nodeVersion":"24.14.1","_npmVersion":"11.11.0","dist":{"integrity":"sha512-tn1BUZuacKM4d99CuVQHb+rttZJANy5kuhfWmjwhyzXMx2Nvv41WguBxVpF9njT/E7iLfyvRtwin8dom4zJF2A==","shasum":"b0f68283eeeb3dd57e5721e0b3d078470122c6f2","tarball":"https://registry.npmjs.org/@vendure-io/docs-generator/-/docs-generator-0.1.1.tgz","fileCount":16,"unpackedSize":58649,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIGbRWdyW41SBc8f+IGj3ZmcbUvgXWhzilPZmR1Cq4GACAiEA9EGFwBMqGsKBQVxMaZgBpapMVHrMHwfbM66KEqCjTLs="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:7c73f13f-d174-41e8-b4df-bbb662409ac8"}},"directories":{},"maintainers":[{"name":"dlhck","email":"d.hoeck@elevantiq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/docs-generator_0.1.1_1776349684905_0.0680060131335436"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-03T08:13:07.739Z","modified":"2026-04-16T14:28:05.206Z","0.1.0":"2026-04-03T08:13:08.000Z","0.1.1":"2026-04-16T14:28:05.066Z"},"bugs":{"url":"https://github.com/vendurehq/vendure-io/issues"},"license":"MIT","homepage":"https://github.com/vendurehq/vendure-io#readme","keywords":["vendure","documentation","docs","typescript","api-reference","codegen"],"repository":{"type":"git","url":"git+https://github.com/vendurehq/vendure-io.git","directory":"libs/docs-generator"},"description":"TypeScript API reference docs generator for Vendure packages","maintainers":[{"name":"dlhck","email":"d.hoeck@elevantiq.com"}],"readme":"# @vendure-io/docs-generator\n\nTypeScript API reference docs generator for Vendure packages. Parses JSDoc annotations from TypeScript source files and renders MDX documentation pages.\n\nComplements [`@vendure-io/docs-provider`](../docs-provider/) which handles manifest compilation and MDX components.\n\n## Usage\n\n```ts\nimport { generateTypescriptDocs, type DocsSectionConfig } from '@vendure-io/docs-generator';\nimport path from 'node:path';\n\nconst sections: DocsSectionConfig[] = [\n    {\n        sourceDirs: ['packages/core/src/', 'packages/common/src/'],\n        exclude: [/generated-types/],\n        outputPath: 'typescript-api',\n    },\n];\n\ngenerateTypescriptDocs(sections, {\n    packagePrefix: '@vendure',\n    repoRoot: path.resolve(__dirname, '../..'),\n    outputRoot: path.resolve(__dirname, '../../docs/docs/reference'),\n});\n```\n\n## Configuration\n\n### `GenerateDocsOptions`\n\n| Option | Description |\n|---|---|\n| `packagePrefix` | Prefix for derived package names, e.g. `'@vendure'` produces `@vendure/core` |\n| `repoRoot` | Absolute path to the repository root |\n| `outputRoot` | Absolute path to the docs output directory |\n| `docsUrl` | Base URL for type hyperlinks (default: `''`) |\n| `isWatchMode` | Skip deleting previously generated docs before regenerating |\n\n### Assumptions\n\n- Source packages are expected to follow a `packages/<name>/` directory layout. Package names are derived from this convention.\n\n## Supported JSDoc Tags\n\n| Tag | Description |\n|---|---|\n| `@docsCategory` | Category path for the declaration (required for inclusion) |\n| `@docsWeight` | Sort weight within category (default: 10) |\n| `@docsPage` | Override page grouping |\n| `@description` | Main documentation text |\n| `@example` | Code examples |\n| `@default` | Default value for properties |\n| `@internal` | Exclude from generated docs |\n| `@since` | Version when introduced |\n| `@experimental` | Mark as experimental |\n","readmeFilename":"README.md"}