42 lines
1.2 KiB
TypeScript
42 lines
1.2 KiB
TypeScript
import { Theme } from "vuepress/core";
|
|
import { ThemeConfig, ThemeNavItem, ThemeNote, ThemeNoteListOptions, 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 配置帮助函数
|
|
*/
|
|
declare function defineNotesConfig(notes: ThemeNoteListOptions): ThemeNoteListOptions;
|
|
/**
|
|
* 主题 notes item 配置帮助函数
|
|
*/
|
|
declare function defineNoteConfig(note: ThemeNote): ThemeNote;
|
|
//#endregion
|
|
export { plumeTheme as default, plumeTheme, defineNavbarConfig, defineNoteConfig, defineNotesConfig, defineThemeConfig }; |