Markdown 语法配置

以下选项在 markdown 中添加了新的语法，可以在主题选项的 markdown 属性下进行设置。

选项

markdown.componentboolean

是否启用组件支持。

参考：组件 → 语法 与 @vuepress/plugin-markdown-ext → component。

markdown.footnotegfm: Yesboolean

是否启用脚注格式支持。

参考：Markdown → 脚注 与 @vuepress/plugin-markdown-ext → footnote。

markdown.imgMarkboolean

是否启用图片标记。

参考：Markdown → 图片标记 与 @vuepress/plugin-markdown-image → mark。

markdown.imgSizeboolean

是否启用图片大小。

参考：Markdown → 图片尺寸 与 @vuepress/plugin-markdown-image → size。

markdown.obsidianImgSizeboolean

是否启用 Obsidian 图片大小。

参考：Markdown → 图片尺寸 与 @vuepress/plugin-markdown-image → obsidianSize。

markdown.legacyImgSize已弃用boolean

是否启用旧版图片大小。

参考：Markdown → 图片尺寸 与 @vuepress/plugin-markdown-image → legacySize。

markdown.includeMarkdownIncludePluginOptions | boolean

是否启用 Markdown 导入支持。你可以传递一个选项来自定义行为。

参考：Markdown → 导入文件 与 @vuepress/plugin-markdown-include。

markdown.include.resolvePath(path: string, cwd: string) => string

默认值(path) => path

处理包含的文件路径。

markdown.include.deepboolean

是否在包含的 Markdown 文件中深度包含文件。

markdown.fieldsboolean

是否启用字段支持。

参考：Markdown → 字段 与 @vuepress/plugin-markdown-field → fields。

markdown.tabsboolean

是否启用选项卡支持。

参考：Markdown → 选项卡 与 @vuepress/plugin-markdown-tab → tabs。

markdown.tasklistgfm: YesMarkdownItTaskListOptions | boolean

是否启用任务列表格式支持。你可以传递一个对象来配置任务列表。

参考：Markdown → 任务列表 与 @vuepress/plugin-markdown-ext → tasklist。

markdown.tasklist.disabledboolean

默认值true

是否禁用复选框。

markdown.tasklist.labelboolean

默认值true

是否使用 <label> 包装文本。

markdown.mathMarkdownMathPluginOptions | boolean

是否启用数学公式支持。你可以设置 true 来自动检测已安装的 katex/mathjax，或提供插件选项。

参考：Markdown → 数学公式 与 @vuepress/plugin-markdown-math。

其类型为：

interface MarkdownKatexPluginOptions extends KatexOptions {
  type?: "katex";

  /**
   * 是否允许两端带空格的内联数学
   *
   * @description 不建议将此设置为 true，因为它很可能会破坏 $ 的默认使用
   *
   * @default false
   */
  allowInlineWithSpace?: boolean;

  /**
   * 是否启用复制插件
   *
   * @default false
   */
  copy?: boolean;

  /**
   * 是否启用化学插件
   *
   * @default false
   */
  mhchem?: boolean;
}

interface MarkdownMathjaxPluginOptions extends Omit<
  MarkdownItMathjaxOptions,
  "transformer"
> {
  type?: "mathjax";

  /**
   * 是否允许两端带空格的内联数学
   *
   * @description 不建议将此设置为 true，因为它很可能会破坏 $ 的默认使用
   *
   * @default false
   */
  allowInlineWithSpace?: boolean;

  /**
   * 输出格式
   *
   * @default 'svg'
   */
  output?: "chtml" | "svg";

  /**
   * 是否启用无障碍
   *
   * @default true
   */
  a11y?: boolean;

  /**
   * TeX 输入选项
   */
  tex?: MathJaxTexInputOptions;

  /**
   * 通用 HTML 输出选项
   */
  chtml?: MathjaxCommonHTMLOutputOptions;

  /**
   * SVG 输出选项
   */
  svg?: MathjaxSVGOutputOptions;
}

type MarkdownMathPluginOptions =
  MarkdownKatexPluginOptions | MarkdownMathjaxPluginOptions;

markdown.revealjsRevealJsPluginOptions | boolean

控制 @vuepress/plugin-revealjs，提供幻灯片支持。你可以设置 true 来直接启用它，或提供插件选项。

参考：Markdown → 幻灯片 与 @vuepress/plugin-revealjs。

markdown.revealjs.pluginsRevealJsPlugin[]

默认值[]

要启用的内置 reveal.js 插件。

可选值：highlight、math、notes、search、zoom。

markdown.revealjs.themesRevealJsTheme[]

默认值["auto"]

要启用的主题。

可选值：auto、beige、black、blood、league、moon、night、serif、simple、sky、solarized、white。