UNPKG

@alauda/doom

Version:

Doctor Doom making docs.

21 lines (20 loc) 1.03 kB
import { type SidebarDivider, type SidebarGroup, type SidebarItem, type SidebarSectionHeader } from '@rspress/core'; import { type NavItem } from '@rspress/shared'; export interface DoomSidebarItem extends SidebarItem { weight?: number; } export type DoomSidebar = DoomSidebarGroup | DoomSidebarItem | SidebarDivider | SidebarSectionHeader; export interface DoomSidebarGroup extends Omit<SidebarGroup, 'items'> { items: DoomSidebar[]; weight?: number; } export declare function scanSideMeta(workDir: string, rootDir: string, docsDir: string, routePrefix: string, extensions: string[], ignoredDirs: string[], onlyIncludeRoutes: string[], excludeRoutes: string[]): Promise<{ index?: DoomSidebarItem; others: DoomSidebar[]; }>; export declare function walk(workDir: string, routePrefix: string | undefined, docsDir: string, extensions: string[], onlyIncludeRoutes?: string[], excludeRoutes?: string[], collapsed?: boolean): Promise<{ nav: NavItem[]; sidebar: { [routePrefix]: DoomSidebar[]; }; }>;