Function: createVitePressSidebarSection()
Creates a VitePress sidebar section from generated API docs navigation.
Signature
ts
export function createVitePressSidebarSection(nav: ApiDocsNavItem[], options: VitePressNavOptions = {}): VitePressSidebarItemParameters
| Name | Type | Description |
|---|---|---|
nav | ApiDocsNavItem[] | API docs navigation metadata. |
options | VitePressNavOptions | VitePress navigation options. (optional, default: {}) |
Returns
VitePressSidebarItem — Generated VitePress sidebar section.
Examples
ts
import { createVitePressSidebarSection } from 'vitepress-api-references'
const apiSection = createVitePressSidebarSection(apiDocsNav, {
section: {
text: 'API Reference',
collapsed: false
}
})