interface AttrsOptions {
  /**
   * 左分隔符
   *
   * @default '{'
   */
  left?: string;

  /**
   * 右分隔符
   *
   * @default '}'
   */
  right?: string;

  /**
   * 允许的属性
   *
   * @description 设置空数组意味着允许所有属性
   *
   * @default []
   */
  allowed?: (string | RegExp)[];
}

默认值: false
详情:
- 定义属性

是否启用自定义属性支持。

sup

类型: boolean
默认值: false
详情:
- 上标

是否启用上角标格式支持。

sub

类型: boolean
默认值: false
详情:
- 下标

是否启用下角标格式支持。

footnote

类型: boolean
默认值: false
详情:
- 脚注

是否启用脚注格式支持。

mark

类型: boolean
默认值: false
详情:
- 标记

是否启用标记格式支持。

tasklist

类型: TaskListOptions | boolean
默认值: false

是否启用任务列表格式支持。你可以传入一个对象作为任务列表的配置选项。

interface TaskListOptions {
  /**
   * 是否禁用 checkbox
   *
   * @default true
   */
  disabled?: boolean;

  /**
   * 是否使用 `<label>` 来包裹文字
   *
   * @default true
   */
  label?: boolean;
}

include

类型: IncludeOptions | boolean

interface IncludeOptions {
  /**
   * 处理 include 文件路径
   *
   * @default (path) => path
   */
  resolvePath?: (path: string, cwd: string) => string;

  /**
   * 是否深度导入包含的 Markdown 文件
   *
   * @default false
   */
  deep?: boolean;
}

默认值: false

是否启用 Markdown 导入支持。你可以传入一个函数进行路径解析。

component

类型: boolean
默认值: false

是否启用组件支持。

chart

类型: boolean
默认值: false

是否启用图表支持。

echarts

类型: boolean
默认值: false

是否启用 ECharts 图表支持。

flowchart

类型: boolean
默认值: false

是否启用流程图支持。

mermaid

类型: MermaidConfig | boolean
默认值: false

是否启用 Mermaid 支持，你可以传入一个对象作为 Mermaid 的配置选项。

plantuml

类型: MarkdownItPlantumlOptions[] | boolean
默认值: false

是否启用 plantuml 支持。

spoiler

类型: boolean
默认值: false

是否启用剧透支持。

stylize

类型: StylizeOptions | false

interface StylizeResult {
  /**
   * 渲染的标签名称
   */
  tag: string;

  /**
   * 属性设置
   */
  attrs: Record<string, string>;

  /**
   * 标签内容
   */
  content: string;
}

interface StylizeItem {
  /**
   * 字符匹配
   */
  matcher: string | RegExp;

  /**
   * 内容替换
   */
  replacer: (options: {
    tag: string;
    content: string;
    attrs: Record<string, string>;
    env?: MarkdownEnv;
  }) => StylizeResult | void;
}

type StylizeOptions = StylizeItem[];

默认值: false

对行内语法进行样式化以创建代码片段

playground

类型: PlaygroundGlobalOptions

interface PlaygroundCodeConfig {
  /**
   * 代码块扩展名
   *
   * @description 它基于文件名，而不是代码块语言
   */
  ext: string;

  /** 代码块内容 */
  content: string;
}

interface PlaygroundData {
  /** 交互演示标题 */
  title?: string;

  /**
   * Import map 文件名
   *
   * @default "import-map.json"
   */
  importMap?: string;

  /** 交互演示文件信息 */
  files: Record<
    /** 文件名 */
    string,
    /** 文件详情 */
    PlaygroundCodeConfig
  >;

  /**
   * 交互演示设置
   *
   * @description 它是设置指令后的 json 内容的解析结果
   */
  settings: Record<string, unknown>;

  /**
   * hash key based on playground content
   *
   * 根据交互演示内容生成的 hash key
   */
  key: string;
}

interface PlaygroundOptions {
  /** 交互演示容器名 */
  name: string;

  /**
   * 交互演示组件名称
   *
   * @default "Playground"
   */
  component?: string;

  /** 属性获取器 */
  propsGetter: (data: PlaygroundData) => Record<string, string>;
}

interface TSPresetPlaygroundOptions extends CompilerOptions {
  /**
   * 交互演示外部地址
   *
   * @default "https://www.typescriptlang.org/play"
   */
  service?: string;
}

interface VuePresetPlaygroundOptions {
  /**
   * 交互演示外部地址
   *
   * @default "https://sfc.vuejs.org/"
   */
  service?: string;

  /**
   * 是否启用开发版本
   *
   * @default false
   */
  dev?: boolean;

  /**
   * 是否启用 SSR
   *
   * @default false
   */
  ssr?: boolean;
}

interface UnoPresetPlaygroundOptions {
  /**
   * 交互演示外部地址
   *
   * @default "https://unocss.dev/play"
   */
  service?: string;
}

type BuiltInPlaygroundPreset = "ts" | "vue" | "unocss";

interface PlaygroundGlobalOptions {
  /** 交互演示预设 */
  presets: (BuiltInPlaygroundPreset | PlaygroundOptions)[];
  /** 交互演示配置 */
  config?: {
    ts?: TSPresetPlaygroundOptions;
    vue?: VuePresetPlaygroundOptions;
    unocss?: UnoPresetPlaygroundOptions;
  };
}