MarkDown

By installing and enableing this plugin, you can use more syntax in your Markdown files.

TIP

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.

At the same time, VuePress itself adds some Markdown syntaxes. You can view the official documentation.

Enable all

You can set themeconfig.mdEnhance.enableAll to enable all features of the markdown-enhance plugin.

module.exports = {
  themeConfig: {
    mdEnhance: {
      enableAll: true,
    },
  },
};

DANGER

Please use this option ONLY for playing or testing.

As time grows,vupress-plugin-markdown-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 use the options below and enable ONLY the feature you want to use.

New Feature

Superscript and Subscript

19^th H₂O

• View Detail

Align

I am center

I am right align

• View Detail

Footnote

This text has footnote^[1].

• View Detail

Mark

You can mark important words .

• View Detail

Tasklist

• Plan A

• Plan B

• View Detail

Mermaid

flowchart TB
    c1-->a2
    subgraph one
    a1-->a2
    end
    subgraph two
    b1-->b2
    end
    subgraph three
    c1-->c2
    end
    one --> two
    three --> two
    two --> c2

• View Detail

Tex

$$\frac {\partial^r} {\partial \omega^r} \left(\frac {y^{\omega}} {\omega}\right) = \left(\frac {y^{\omega}} {\omega}\right) \left\{(\log y)^r + \sum_{i=1}^r \frac {(-1)^i r \cdots (r-i+1) (\log y)^{r-i}} {\omega^i} \right\}$$

• View Detail

Code Demo

::: demo A normal demo

<h1>Mr.Hope</h1>
<p>Is <span id="very">very</span> handsome</p>

document.querySelector("#very").addEventListener("click", () => {
  alert("Very handsome!");
});

span {
  color: red;
}

:::

• View Detail

Presentation

@slidestart

Slide 1

A paragraph with some text and a link

---

Slide 2

• Item 1
• Item 2

---

Slide 3.1

const a = 1;

–

Slide 3.2

$$J(\theta_0,\theta_1) = \sum_{i=0}$$

@slideend

• View Detail

---

1. This is footnote content ↩︎