Others

Link check

The theme will use @vuepress/plugin-links-check to check your Markdown links by default.

You can customize this feature through markdown.linksCheck in theme options, check links-check docs for more details.

GFM

If your docs both serve on documentation site and directly on GitHub, we provide markdown.gfm in theme options to align your Markdown behavior with GitHub.

Important

For full GFM syntax, see GFM.

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.

v-pre

Since VuePress2 has removed V1's v-pre container in core, we provide markdown.vPre option to support it. You can use any Mustache syntax in v-pre container when enabling this:

{{ abc }}

::: v-pre

{{ abc }}

:::