Function: generateOxContentApiDocs()

Generates API reference markdown, navigation metadata, and optional artifacts.

Signature

export async function generateOxContentApiDocs(options: OxContentApiDocsOptions): Promise<OxContentApiDocsResult>

Parameters

Name	Type	Description
options	OxContentApiDocsOptions	API docs generation options.

Returns

Promise<OxContentApiDocsResult> — Generated API docs files, metadata, diagnostics, and resolved options.

Examples

import { generateOxContentApiDocs } from 'vitepress-api-references'

const result = await generateOxContentApiDocs({
  entryPoints: ['src/index.ts'],
  outDir: 'docs/api',
  basePath: '/api'
})

console.log(result.generatedFiles)