import type { LocaleConfig } from '@vuepress/core'; import type { KatexOptions } from 'katex'; import type { CodeDemoOptions } from './code-demo'; import type { MarkdownEnhanceI18nConfig } from './locales'; import type { PresentationOptions } from './presentation'; import type { TaskListOptions } from './tasklist'; /** * markdown-enhance plugin configuration */ export declare type MarkdownEnhanceOptions = Partial<{ /** * 是否启用自定义容器 * * - info * - tip * - warning * - danger * - details * * ⚠ 最后四个会和默认主题冲突,且可能会覆盖默认主题的样式与行为 * * Whether to enable custom container including * * - info * - tip * - warning * - danger * - details * * ⚠ The last 4 is conflict with default theme and may overide it. * * @default false */ customContainer: boolean; /** * 是否启用自定义对齐支持 * * Whether to enable align support * * @default false */ align: boolean; /** * 是否启用上角标格式支持 * * Whether to enable superscript format support * * @default false */ sup: boolean; /** * 是否启用下角标格式支持 * * Whether to enable subscript format support * * @default false */ sub: boolean; /** * 是否启用脚注格式支持 * * Whether to enable footnote format support * * @default false */ footnote: boolean; /** * 是否启用流程图 * * Whether to enable flowchart format support * * @default false */ flowchart: boolean; /** * 是否启用标注支持 * * Whether to enable mark format support * * @default false */ mark: boolean; /** * 是否启用任务里表支持 * * Whether to enable tastlist format support * * @default false */ tasklist: TaskListOptions | boolean; /** * 是否启用 TeX 语法支持 * * Whether to enable TeX syntax support * * @default false */ tex: KatexOptions | boolean; /** * 是否启用 Mermaid 流程图支持 * * Whether to enable mermaid support * * @default false */ mermaid: boolean; /** * 是否启用代码示例功能 * * Whether to enable code-demo support * * @default false */ demo: Partial | boolean; /** * 是否启用幻灯片支持 * * Whether to enable presentation support * * @default false */ presentation: PresentationOptions | boolean; /** * 是否启用全部增强 * * Whether to enable all features. * * @default false */ enableAll: boolean; /** * 操作页面 DOM 的延时,单位 ms * * 如果你使用的主题有切换动画,建议配置此选项为 `切换动画时长 + 200` * * The delay of operating dom, in ms * * If the theme you are using has a switching animation, it is recommended to configure this option to `Switch animation duration + 200` * * @default 500 */ delay?: number; /** * 国际化配置选项 * * I18n config */ locales?: LocaleConfig; }>;