Function: toVitePressSidebarItems()

Converts API docs navigation metadata into VitePress sidebar items.

Signature

export function toVitePressSidebarItems(nav: ApiDocsNavItem[], options: VitePressNavOptions = {}): VitePressSidebarItem[]

Parameters

Name	Type	Description
nav	ApiDocsNavItem[]	API docs navigation metadata.
options	VitePressNavOptions	VitePress navigation options. (optional, default: {})

Returns

VitePressSidebarItem[] — Generated VitePress sidebar items.

Examples

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

const sidebarItems = toVitePressSidebarItems([
  {
    title: 'API',
    path: '/api/',
    children: [{ title: 'withOxContentApiDocs', path: '/api/with-ox-content-api-docs' }]
  }
])