Enable Enhance

Mr.Hope ... February 26, 2021 16:10 Markdown
  • Intro
  • Markdown
Less than 1 minute

Besides Markdown syntaxes VuePress itself adds, vuepress-theme-hope enables more syntax in Markdown via vuepress-plugin-md-enhance (opens new window) plugin.

# Built-in enhancements

VuePress comes with GitHub-style tables, Emoji, TOC, code line numbers, specific line highlighting, etc. are all available out of the box.

For detailed syntax, please refer to Built-in Markdown Enhance.

# Enable Markdown Enhance

themeconfig.mdEnhance in .vuepress/config.js will be passed directly to the plugin as a plugin option. Visit md-enhance documentation (opens new window) to see the usage.

Tips

Don’t worry about the size of your site. If you don’t enable related features, the final code won’t include code for these features.

# Enable all

You can set themeconfig.mdEnhance.enableAll to enable all features of the md-enhance (opens new window) plugin.



 
 
 



module.exports = {
  themeConfig: {
    mdEnhance: {
      enableAll: true,
    },
  },
};
1
2
3
4
5
6
7

Warning

Please use this option ONLY for playing or testing.

As time grows,vupress-plugin-md-enhance is becoming more powerful. It’s adding more syntax to Markdown parser and more code to output.

Enabling features you don’t need will increase dev and build time. (markdown-it has to check for extra syntaxs)

Also, presentation feature will add a 700KB size chunk (mostly is reveal.js) to your output.

Please enable ONLY the feature you want to use.

# Enable specific syntax

Specific syntax configuration items can be found in the corresponding instruction page or Theme Plugin Config.