typedoc
Options for generating API documentation with TypeDoc
typedoc
Options for generating API documentation with TypeDoc. Set to false to disable.
Type: TypeDocumentOptions | false
Default: {}
Quick Setup
Use the add command to automatically configure TypeDoc:
npx packem add typedocThis will:
- Add TypeDoc builder configuration to your
packem.config.ts - Install TypeDoc and related plugins
- Set up the builder for documentation generation
Example
export default defineConfig({
typedoc: {
format: 'markdown',
output: 'docs/api'
}
})