Markdown Behavior Config

The following options change Markdown renderer behaviors, and can be set under markdown property in theme options.

Options

markdown.gfmboolean

Whether to support GFM.

Important

Only common GFM syntax are supported, and some of the behaviors might be different.

For example, to support Vue syntax, <script> tags are allowed
in VuePress.

See also: Markdown → GFM and @vuepress/plugin-markdown-ext → gfm.

markdown.vPreboolean

Whether to enable v-pre wrapper.

See also: v-pre wrapper and @vuepress/plugin-markdown-ext → vPre.

markdown.breaksgfm: Yesboolean

Whether to convert \n in paragraphs into <br>s.

See also: @vuepress/plugin-markdown-ext → breaks.

markdown.linkifygfm: Yesboolean

Whether to convert URL-like text into links.

See also: @vuepress/plugin-markdown-ext → linkify.

markdown.cjkFriendlyboolean

Default Auto

Whether to enable CJK-friendly support for emphasis marks. When not set, it's automatically enabled for CJK languages (zh, ja, ko) detected in site configuration.

See also: @vuepress/plugin-markdown-ext → cjkFriendly.

markdown.figureboolean

Whether to convert standalone <img> into <figure>.

See also: Markdown → Figure and @vuepress/plugin-markdown-image → figure.

markdown.imgLazyloadboolean

Whether to enable lazy loading for images in Markdown.

See also: Markdown → Image Lazy Loading and @vuepress/plugin-markdown-image → lazyload.

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

Default"shiki"

Controls Markdown code block highlighter. You can choose "prismjs", "shiki", false or an object with type field declaring the highlighter name and other plugin options.

• "prismjs": Use @vuepress/plugin-prismjs.
• "shiki": Use @vuepress/plugin-shiki.
• false: Disable code block highlighting.

See also: Feature → Code Block.

Its type is:

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

markdown.linksCheckenabled-by-default: YesLinksCheckPluginOptions | boolean

Defaulttrue

Whether to enable @vuepress/plugin-links-check plugin, which provides link check for Markdown. You can manually set a boolean value to control the plugin status, or provide plugin options.

See also: Markdown → Link check and @vuepress/plugin-links-check.