vitepress-auto-nav
Version:
Auto-generate navigation and sidebar configuration for VitePress
22 lines (21 loc) • 932 B
TypeScript
import type { DefaultTheme } from 'vitepress';
import type { VitepressAutoNavOptions, VitepressConfigResult } from './types';
/**
* Generate VitePress navigation bar configuration
* @param options Configuration options
* @returns Navigation bar configuration array
*/
export declare function generateNav(options?: VitepressAutoNavOptions): DefaultTheme.NavItem[];
/**
* Generate VitePress sidebar configuration
* @param options Configuration options
* @returns Sidebar configuration object
*/
export declare function generateSidebar(options?: VitepressAutoNavOptions): DefaultTheme.Sidebar;
/**
* Automatically generate navigation bar and sidebar configuration
* @param options Configuration options
* @returns Object containing navigation bar and sidebar configuration
*/
export declare function generateVitepressConfig(options?: VitepressAutoNavOptions): VitepressConfigResult;
export default generateVitepressConfig;