$ cd /home/

plugin-md-plus

Gungnir
2021-12-27
3 min

npmgithublicense

A plugin for enhancing Markdown in VuePress 2. Now the following features are supported:

Install

pnpm install @renovamen/vuepress-plugin-md-plus@next

yarn add @renovamen/vuepress-plugin-md-plus@next

npm install @renovamen/vuepress-plugin-md-plus@next

Configuration

You can enable all features simply by:

const { mdPlusPlugin } = require("@renovamen/vuepress-plugin-md-plus");

module.exports = {
  plugins: [
    mdPlusPlugin({
      all: true // Enable all features or not, this will rewrite all the following options (default: false)
    })
  ]
};

or enable them separately:

module.exports = {
  plugins: [
    mdPlusPlugin({
      footnote: true, // Enable footnote or not (default: false)
      mark: true // Enable mark or not (default: false)
      sub: true // Enable Subscript or not (default: false)
      sup: true // Enable Superscript or not (default: false)
    })
  ]
};

Usage

Footnote

Add footnotes for text[1]

Syntax
Add footnotes for text[^1]

[^1]: Write your footnote here.

Mark

Mark important information: "Excuse me. Can you tell me how much the shirt is?" "Yes, it's nine fifteen."

Syntax
Mark important information: "Excuse me. Can you tell me how much the shirt is?" "Yes, it's ==nine fifteen==."

Subscript

H2O

Syntax
H~2~O

Superscript

29th

Syntax
29^th^

  1. Write your footnote here. ↩︎