vue-docs-ui/dist/types/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 { App } from '../vue/dist/vue.esm-bundler.js';
import { default as DocsLayout } from './components/DocsLayout.vue';
import { default as DefaultHome } from './views/DefaultHome.vue';
import { default as DefaultArticle } from './views/DefaultArticle.vue';
import { default as HeaderNav } from './components/HeaderNav.vue';
import { default as SidebarNav } from './components/SidebarNav.vue';
import { default as TableOfContents } from './components/TableOfContents.vue';
import { default as MarkdownRenderer } from './components/MarkdownRenderer.vue';
import { default as ThemeSwitcher } from './components/ThemeSwitcher.vue';
import { loadConfig, generateRoutesFromSidebar, getNormalizedSidebar, getNormalizedNavbar } from './utils/index';
export type { DocsConfig, NavItem, SidebarSection, ThemeConfig } from './types';
export { DocsLayout, HeaderNav, SidebarNav, TableOfContents, MarkdownRenderer, ThemeSwitcher, DefaultHome, DefaultArticle };
export { loadConfig, generateRoutesFromSidebar, getNormalizedSidebar, getNormalizedNavbar };
export declare function createDocsApp(options?: {
    configPath?: string;
    el?: string;
    customComponents?: {
        home?: any;
        article?: any;
    };
}): Promise<{
    app: App<Element>;
    router: import('vue-router').Router;
    config: import('./types').DocsConfig;
    mountedApp: import('../vue/dist/vue.esm-bundler.js').ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import('../vue/dist/vue.esm-bundler.js').ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import('../vue/dist/vue.esm-bundler.js').ComponentProvideOptions>, {}, {}, "", {}, any>;
}>;
export interface DocsUIOptions {
    config?: any;
    router?: any;
}
export declare function createDocsUI(options?: DocsUIOptions): {
    install(app: App): void;
};
export default createDocsApp;