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

A Blog&Document Theme for VuePress 2.0

import { Theme } from "vuepress/core";
import { ThemeCollectionItem, ThemeCollections, ThemeConfig, ThemeNavItem, ThemeOptions } from "../shared/index.js";
export * from "../shared/index.js";

//#region src/node/theme.d.ts

/**
 * VuePress Theme Plume
 * @param options 主题配置
 * @example
 * ```ts
 * import { defineUserConfig } from 'vuepress'
 * import { plumeTheme } from 'vuepress-theme-plume'
 *
 * export default defineUserConfig({
 *   theme: plumeTheme({
 *     // ...options
 *   })
 * })
 * ```
 */
declare function plumeTheme(options?: ThemeOptions): Theme;
//#endregion
//#region src/node/defineConfig.d.ts
/**
 * 主题配置，在单独的 `plume.config.ts` 中使用的类型帮助函数
 */
declare function defineThemeConfig(config: ThemeConfig): ThemeConfig;
/**
 * 主题导航栏配置帮助函数
 */
declare function defineNavbarConfig(navbar: ThemeNavItem[]): ThemeNavItem[];
/**
 * 主题 notes 配置帮助函数
 * @deprecated 使用 `defineCollections` 代替
 */
declare function defineNotesConfig(notes: unknown): unknown;
/**
 * 主题 notes item 配置帮助函数
 * @deprecated 使用 `defineCollection` 代替
 */
declare function defineNoteConfig(note: unknown): unknown;
/**
 * 主题 collections 配置帮助函数
 */
declare function defineCollections(collections: ThemeCollections): ThemeCollections;
/**
 * 主题 collections item 配置帮助函数
 */
declare function defineCollection(collection: ThemeCollectionItem): ThemeCollectionItem;
//#endregion
export { plumeTheme as default, plumeTheme, defineCollection, defineCollections, defineNavbarConfig, defineNoteConfig, defineNotesConfig, defineThemeConfig };