Markdown 行为配置

下列选项更改 Markdown 渲染器行为，可以在主题选项中的 markdown 属性下设置。

选项

markdown.gfmboolean

是否支持 GFM。

重要

只支持常见的 GFM 语法，有些行为可能会有所不同。

例如，为了支持 Vue 语法，VuePress 允许在 <script> 标签中使用。

参考：Markdown → GFM 与 @vuepress/plugin-markdown-ext → gfm。

markdown.vPreboolean

是否启用 v-pre 容器。

参考：v-pre 容器 与 @vuepress/plugin-markdown-ext → vPre。

markdown.breaksgfm: Yesboolean

是否将段落中的 \n 转换为 <br>。

参考：@vuepress/plugin-markdown-ext → breaks。

markdown.linkifygfm: Yesboolean

是否将文本中的 URL 转换为链接。

参考：@vuepress/plugin-markdown-ext → linkify。

markdown.cjkFriendlyboolean

默认值 自动

是否启用针对强调标记的 CJK 友好支持。未设置时，会为站点配置中检测到的 CJK 语言（zh、ja、ko）自动启用。

参考：@vuepress/plugin-markdown-ext → cjkFriendly。

markdown.figureboolean

是否将独立的 <img> 转换为 <figure>。

参考：Markdown → 图片展示 与 @vuepress/plugin-markdown-image → figure。

markdown.imgLazyloadboolean

是否启用图片懒加载。

参考：Markdown → 图片懒加载 与 @vuepress/plugin-markdown-image → lazyload。

markdown.highlighterMarkdownHighlighterOptions | "prismjs" | "shiki" | false

默认值"shiki"

Markdown 代码块高亮器。可以选择 "prismjs"、"shiki"、false 或一个带有 type 字段的对象，声明高亮器名称和其他插件选项。

• "prismjs": 使用 @vuepress/plugin-prismjs。
• "shiki": 使用 @vuepress/plugin-shiki。
• false: 禁用代码块高亮。

参考：功能 → 代码块。

其类型为：

type MarkdownHighlighterOptions =
  | ({ type: "prismjs" } & PrismjsPluginOptions)
  | ({ type: "shiki" } & ShikiPluginOptions);

markdown.linksCheckenabled-by-default: YesLinksCheckPluginOptions | boolean

默认值true

是否启用 @vuepress/plugin-links-check 插件，提供 Markdown 链接检查。你可以手动设置一个布尔值来控制插件状态，或提供插件选项。

参考：Markdown → 链接检查 与 @vuepress/plugin-links-check。