vite-plugin-vitepress-auto-sidebar/dist/index.d.ts

The vite plugin that automatically generates sidebar data by scanning directories, based on vitepress

import { Plugin } from 'vite';
import { DefaultTheme } from 'vitepress';

interface SidebarPluginOptionType {
    ignoreList?: Array<RegExp | string>;
    path?: string;
    createIndex?: boolean;
    ignoreIndexItem?: boolean;
    deletePrefix?: string | RegExp;
    collapsed?: boolean;
    titleFromFile?: boolean;
    titleFromFileByYaml?: boolean;
    scanRootMdFiles?: boolean;
    sideBarResolved?: (data: DefaultTheme.SidebarMulti) => DefaultTheme.SidebarMulti;
    sideBarItemsResolved?: (data: DefaultTheme.SidebarItem[]) => DefaultTheme.SidebarItem[];
    beforeCreateSideBarItems?: (data: string[]) => string[];
}

declare function VitePluginVitePressAutoSidebar(opt?: SidebarPluginOptionType): Plugin;

export { VitePluginVitePressAutoSidebar as default };