Markdown Enhance

Every document page in VuePress is rendered by Markdown.

You need to build your document or blog page by creating and writing Markdown in the corresponding path.

Markdown introduction

If you are a new learner and don’t know how to write Markdown, please read Markdown Intro and Markdown Demo.

Frontmatter

Frontmatter is a important concept in VuePress. If you don’t know it, you need to read Frontmatter Introduction.

VuePress Enhancement

To enrich document writing, VuePress has extended Markdown syntax.

For these extensions, please read Markdown extensions in VuePress.

Theme Enhancement

Enable all

You can set themeconfig.plugins.htmlEnhance.enableAll to enable all features of the md-enhance plugin.

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

New Feature

Custom Container

Safely use {{ variable }} in markdown.

Custom Title

A custom information container with code, link.

const a = 1;

Custom Title

A custom tip container

Custom Title

A custom warning container

Custom Title

A custom danger container

Custom Title

A custom details container

Code

::: v-pre

Safely use {{ variable }} in markdown.

:::

::: info Custom Title

A custom information container

:::

::: tip Custom Title

A custom tip container

:::

::: warning Custom Title

A custom warning container

:::

::: danger Custom Title

A custom danger container

:::

::: details Custom Title

A custom details container

:::

CodeGroup

yarn add -D vuepress-theme-hope

npm i -D vuepress-theme-hope

• View Detail

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

Chart

A Scatter Chart

• View Detail

Flowchart

• View Detail

Mermaid

• 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

<h1>VuePress Theme Hope</h1>
<p>Is <span id="very">very</span> powerful!</p>

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

span {
  color: red;
}

A normal demo

• View Detail

Presentation

• View Detail

---

1. This is footnote content ↩︎