Interface: OxContentApiDocsOptions
User-facing options for generating API reference markdown and VitePress integration.
Signature
ts
export interface OxContentApiDocsOptionsProperties
| Name | Type | Description |
|---|---|---|
basePath | string | Base route used when generating links between API docs pages. |
clean (optional) | boolean | Whether generated output should be cleaned before writing. Default: undefined |
docsJson (optional) | boolean | string | Whether to write docs JSON, or the output path to write it to. Default: undefined |
entryPoints | EntryPointInput[] | Source entry points whose exported declarations become API docs pages. |
escapeHeadingAngleBrackets (optional) | boolean | Escape < and > in markdown heading lines to avoid HTML parsing in VitePress. Default: false |
extraction (optional) | OxContentExtractionOptions | Controls which declarations and metadata are extracted from entry points. Default: {} |
githubUrl (optional) | string | GitHub repository URL used to generate source links for declarations. Default: undefined |
markdown (optional) | OxContentMarkdownOptions | Controls markdown page generation, grouping, sorting, and rendering details. Default: {} |
nav (optional) | VitePressNavOptions | Controls generated VitePress sidebar integration and optional nav artifacts. Default: { enabled: true, insert: 'append', virtualModule: false } |
outDir | string | URL | Directory where generated markdown and optional artifacts are written. |
root (optional) | string | URL | Project root used to resolve relative paths. Default: process.cwd() |
tsconfig (optional) | string | URL | TypeScript configuration file used for declaration extraction. Default: undefined |
write (optional) | boolean | Whether generated files and artifacts are written to disk. Default: true |