MdEnhance Plugin Config

About 3 min

Introduction

The vuepress-plugin-md-enhance plugin is enabled by default and provides Markdown enhancements.

vuepress-theme-hope passes plugins.mdEnhance in theme options as plugin options to vuepress-plugin-md-enhance plugin.

Tips

If you don’t need this feature, please set to false.

Info

vuepress-theme-hope will set the container option to true by default.

See the md-enhance documentationopen in new window for more details.

Plugin Options

enableAll Demo only

  • Type: boolean
  • Default: false

Whether to enable all features.

Warning

Please use this option ONLY for playing or testing.

The plugin is FULLY treeshakable, so you should use the options below and enable ONLY the feature you want to use.

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

Also, some feature will add large chunks to your output (can up to 2MB).

gfm

  • Type: boolean
  • Default: false

Whether to support full GFM syntax.

Note

For full GFM syntax, see GFMopen in new window.

We are not 100% supporting it to be honestly, we only supply it’s syntax inlucding tasklists, footnote and so on.

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

container

  • Type: boolean
  • Default: true

Whether to enable custom container including

  • info
  • note
  • tip
  • warning
  • danger
  • details

linkCheck

  • Type: "always" | "dev" | "build" | "never" | boolean
  • Default: "dev"

Whether to enable link check.

Note

  • true equals to 'always'
  • false equals to 'never'

vpre

  • Type: boolean
  • Default: false

Whether to enable v-pre wrapper.

tabs

  • Type: boolean
  • Default: false

Whether to enable tabs.

codetabs

  • Type: boolean
  • Default: false

Whether to enable codetabs.

align

  • Type: boolean
  • Default: false

Whether to enable custom align.

sup

  • Type: boolean
  • Default: false

Whether to enable the upper format support.

sub

  • Type: boolean
  • Default: false

Whether to enable the lower corner format support.

footnote

  • Type: boolean
  • Default: false

Whether to enable footnote format support.

lazyLoad

  • Type: boolean
  • Default: false

Whether to lazy load every images in page in native way.

mark

  • Type: boolean
  • Default: false

Whether to enable mark support.

imageMark

  • Type: ImageMarkOptions | boolean
  • Default: false

Whether enable image mark support.

interface ImageMarkOptions {
  /** lightmode only IDs */
  light?: string[];
  /** darkmode only IDs */
  dark?: string[];
}

tasklist

  • Type: TaskListOptions | boolean
  • Default: false

Whether to enable tasklist format support. You can pass an object to config task list.

interface TaskListOptions {
  /**
   * Whether disable checkbox
   *
   * @default true
   */
  disabled?: boolean;

  /**
   * Whether use `<label>` to wrap text
   *
   * @default true
   */
  label?: boolean;
}

tex

  • Type: KatexOptions | boolean
  • Default: false

Whether to enable TeX\TeX syntax support. You can pass an object to config KaTeX\KaTeX.

Please see Katex Docsopen in new window for available options.

flowchart

  • Type: boolean
  • Default: false

Whether to enable flowchart support

mermaid

  • Type: boolean
  • Default: false

Whether to enable Mermaidopen in new window support.

stylize

  • Type: StylizeOptions | false

    interface StylizeResult {
      /**
       * Tag name
       */
      tag: string;
    
      /**
       * Attributes settings
       */
      attrs: Record<string, string>;
    
      /**
       * Tag content
       */
      content: string;
    }
    
    interface StylizeItem {
      /**
       * Inline token matcher
       */
      matcher: string | RegExp;
    
      /**
       * Content Replacer
       */
      replacer: (options: {
        tag: string;
        content: string;
        attrs: Record<string, string>;
        env?: MarkdownEnv;
      }) => StylizeResult | void;
    }
    
    type StylizeOptions = StylizeItem[];
    
  • Default: false

Stylize inline tokens to create snippet you want.

demo

  • Type: CodeDemoGlobalOptions | boolean
  • Default: false

Whether to enable code demo support.

demo.jsLib

  • Type: string[]
  • Required: No

CodePen, JsFiddle requires an external JS library for dating.

demo.cssLib

  • Type: string[]
  • Required: No

CodePen, JsFiddle need an external CSS library for dating.

Note

The above two options are only used by third-party code demo service, you need to import these libraries in head.

demo.jsfiddle

  • Type: boolean
  • Default value: true

Whether to display the JSFiddle button

demo.codepen

  • Type: boolean
  • Default value: true

Whether to display the CodePen button

demo.codepenLayout

  • Type: "top" | "left" | "correct"
  • Default value: "left"

CodePen editor layout

demo.codepenEditors

  • Type: string
  • Default value: "101"

CodePen editor status

others

The following are the library links used by the third-party code demo service. Unless your environment cannot visit unpkg or the speed is slow, you probably don’t need to override the default values.

demo.babel

Default value: "https://unpkg.com/@babel/standalone/babel.min.js"

demo.vue

Default value: "https://unpkg.com/vue/dist/vue.global.prod.js"

demo.react

Default value: "https://unpkg.com/react/umd/react.production.min.js"

demo.reactDOM

Default value: "https://unpkg.com/react-dom/umd/react-dom.production.min.js"

presentation

  • Type: PresentationOptions | boolean
  • Default: false

Whether to enable presentation syntax support.

You can set it with an object, the object will be used to config reveal.js.

presentation.plugins

  • Type: RevealPlugin[]

    type RevealPlugin = "highlight" | "math" | "search" | "notes" | "zoom";
    
  • Required: No

Plugins you want to use on reveal.js.

Acceptable values are:

  • "highlight"
  • "math"
  • "search"
  • "notes"
  • "zoom"

presentation.revealConfig

  • Type: Partial<RevealOptions>
  • Required: No

Config which you want to pass to reveal.js.

delay

  • Type: number
  • Default: 500

The delay of operating dom, in ms.

Tips

If the theme you are using has a switching animation, it is recommended to configure this option to Switch animation duration + 200.

locales

  • Type: MarkdownEnhanceLocaleConfig

    interface MarkdownEnhanceLocaleData {
      /**
       * Default Title text for info block
       */
      info: string;
    
      /**
       * Default Title text for note block
       */
      note: string;
    
      /**
       * Default Title text for tip block
       */
      tip: string;
    
      /**
       * Default Title text for warning block
       */
      warning: string;
    
      /**
       * Default Title text for danger block
       */
      danger: string;
    
      /**
       * Default Title text for details block
       */
      details: string;
    }
    
    interface MarkdownEnhanceLocaleConfig {
      [localePath: string]: MarkdownEnhanceLocaleData;
    }
    
  • Required: No

Locales config for Markdown Enhance Plugin.

Loading...