vuepress-theme-plume/lib/node/index.d.ts

A Blog&Document Theme for VuePress 2.0

import { Theme } from 'vuepress/core';
import { ThemeOptions, ThemeConfig, ThemeNavItem, ThemeNoteListOptions, ThemeNote } from '../shared/index.js';
export * from '../shared/index.js';

declare function plumeTheme(options?: ThemeOptions): Theme;

/**
 * 主题配置，在单独的 `plume.config.ts` 中使用的类型帮助函数
 */
declare function defineThemeConfig(config: ThemeConfig): ThemeConfig;
/**
 * 主题导航栏配置帮助函数
 */
declare function defineNavbarConfig(navbar: ThemeNavItem[]): ThemeNavItem[];
/**
 * 主题 notes 配置帮助函数
 */
declare function defineNotesConfig(notes: ThemeNoteListOptions): ThemeNoteListOptions;
/**
 * 主题 notes item 配置帮助函数
 */
declare function defineNoteConfig(note: ThemeNote): ThemeNote;

export { plumeTheme as default, defineNavbarConfig, defineNoteConfig, defineNotesConfig, defineThemeConfig, plumeTheme };