Markdown Behavior Config

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

markdown.gfm

• Type: boolean
• Default: false
• Details:
  • Markdown → GFM
  • @vuepress/plugin-markdown-ext → gfm

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.

markdown.vPre

• Type: boolean
• Default: false
• Details:
  • v-pre wrapper
  • @vuepress/plugin-markdown-ext → vPre

Whether to enable v-pre wrapper.

markdown.breaks

• Type: boolean
• Default: false
• Enabled in GFM: Yes
• Details:
  • @vuepress/plugin-markdown-ext → breaks

Whether convert \n in paragraphs into <br>s

markdown.linkify

• Type: boolean
• Default: false
• Enabled in GFM: Yes
• Details:
  • @vuepress/plugin-markdown-ext → linkify

Whether convert URL-like text into links

markdown.figure

• Type: boolean
• Default: false
• Details:
  • Markdown → Figure
  • @vuepress/plugin-markdown-image → figure

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

markdown.imgLazyload

• Type: boolean
• Default: false
• Details:
  • Markdown → Image Lazy Loading
  • @vuepress/plugin-markdown-image → lazyload

Whether to enable lazy loading for images in markdown.

markdown.highlighter

• Type: MarkdownHighlighterOptions | "prismjs" | "shiki" | false

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

• Default: "shiki"

• Details:

  • Feature → Code Block

The 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.

markdown.linksCheck Enabled by default

• Type: LinksCheckPluginOptions | Options
• Default: true
• Details:
  • Markdown → Link check
  • @vuepress/plugin-links-check

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.