Skip to main content


Less than 1 minuteMarkdownMarkdown

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

You can customize this feature through plugins.linksCheck in theme options, check links-check docsopen in new window for more details.


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


For full GFM syntax, see GFMopen in new window.

We are not 100% supporting it to be honestly, we only supply its syntax including linkify, breaks, footnote, task list, code highlight, image mark, mermaid, mathjax and so on.

Some of the behavior might be different, for example to support Vue syntax, we are not disallowing <script> tags. But in most situation, the behavior should be same.

Besides, custom container is enabled by default in @vuepress/theme-default and vuepress-theme-hope, but not available in GitHub Markdown preview.


Since VuePress2 has removed V1's v-pre container in core, the plugin provides vPre option to support it. That is, you can use any Mustache syntax in the container below.

{{ abc }}

::: v-pre

{{ abc }}