Interface: ResolvedOxContentApiDocsOptions

API docs options after defaults are applied and all paths are normalized.

Extends

• Omit<OxContentApiDocsOptions, 'root' | 'tsconfig' | 'entryPoints' | 'outDir' | 'extraction' | 'nav'>

Signature

export interface ResolvedOxContentApiDocsOptions extends Omit<
  OxContentApiDocsOptions,
  'root' | 'tsconfig' | 'entryPoints' | 'outDir' | 'extraction' | 'nav'
>

Properties

Name	Type	Description
entryPoints	JsEntryPointSpec[]	Entry point specs with paths resolved to absolute filesystem paths.
extraction	ResolvedOxContentExtractionOptions	Extraction options with defaults applied and external package paths resolved.
nav	Required<Pick<VitePressNavOptions, 'enabled' | 'insert' | 'virtualModule'>> & Omit<VitePressNavOptions, 'enabled' | 'insert' | 'virtualModule'>	VitePress navigation options with default integration settings applied.
outDir	string	Absolute output directory for generated markdown and optional artifacts.
root	string	Absolute project root used as the base for all relative inputs.
tsconfig (optional)	string	Absolute TypeScript configuration path, when configured. Default: undefined