vue-docs-ui/dist/types/utils/index.d.ts

A modern documentation UI component library built with Vue 3. Create beautiful documentation websites with YAML configuration and Markdown rendering - ready to use out of the box.

import { RouteRecordRaw } from 'vue-router';
import { DocsConfig, SidebarSection, TocItem, NavItem } from '../types';
export declare function loadConfig(configPath: string): Promise<DocsConfig>;
export declare function getNormalizedSidebar(config: DocsConfig): SidebarSection[];
export declare function getNormalizedNavbar(config: DocsConfig): NavItem[];
export declare function generateRoutesFromSidebar(sidebar: SidebarSection[] | {
    sections: SidebarSection[];
} | any, articleComponent?: any): RouteRecordRaw[];
export declare function createDocsRouter(config: DocsConfig, base?: string, componentResolver?: (path: string) => any): import('vue-router').Router;
export declare function parseMarkdownHeaders(content: string, maxDepth?: number): TocItem[];
export declare function getDefaultTocConfig(config?: DocsConfig): {
    depth: number;
    enabled: boolean;
};