Function: mergeVitePressSidebar()

Merges generated API docs sidebar data into an existing VitePress sidebar.

Signature

export function mergeVitePressSidebar(sidebar: unknown, generated: VitePressSidebarItem, options: MergeVitePressSidebarOptions = {}): unknown

Parameters

Name	Type	Description
sidebar	unknown	Existing VitePress sidebar configuration.
generated	VitePressSidebarItem	Generated API docs sidebar section.
options	MergeVitePressSidebarOptions	Sidebar merge options. (optional, default: {})

Returns

unknown — Updated VitePress sidebar configuration.

Examples

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

const sidebar = mergeVitePressSidebar(
  [{ text: 'Guide', link: '/guide/' }],
  { text: 'API Reference', items: [{ text: 'Config', link: '/api/config' }] },
  { insert: 'append' }
)