API Documentation
Generated by Ox Content
Entrypoint for vitepress-api-references package
Example
ts
import { withOxContentApiDocs } from 'vitepress-api-references'14 symbols · 5 functions · 9 interfaces · 10 parameters · 50 members · 5 returns · 6 examples
Functions
| Function | Description |
|---|---|
| createVitePressSidebarSection | Creates a VitePress sidebar section from generated API docs navigation. |
| generateOxContentApiDocs | Generates API reference markdown, navigation metadata, and optional artifacts. |
| mergeVitePressSidebar | Merges generated API docs sidebar data into an existing VitePress sidebar. |
| toVitePressSidebarItems | Converts API docs navigation metadata into VitePress sidebar items. |
| withOxContentApiDocs | Adds generated API docs pages, sidebar data, and watch support to a VitePress config. |
Interfaces
| Interface | Description |
|---|---|
| ApiDocsNavItem | Navigation item generated from API docs metadata. |
| MergeVitePressSidebarOptions | Options for merging generated sidebar items into an existing VitePress sidebar. |
| OxContentApiDocsOptions | User-facing options for generating API reference markdown and VitePress integration. |
| OxContentApiDocsResult | Result produced by API docs generation. |
| OxContentExtractionOptions | Controls which declarations and metadata ox-content extracts from entry points. |
| OxContentMarkdownOptions | Markdown rendering options forwarded to ox-content after project defaults are applied. |
| ResolvedOxContentApiDocsOptions | API docs options after defaults are applied and all paths are normalized. |
| VitePressNavOptions | Configures generated VitePress sidebar data and optional navigation artifacts. |
| VitePressSidebarItem | Minimal VitePress sidebar item shape used by generated API docs. |