Markdown Enhance

Mr.BlueAbout 3 minGuideMarkdown

VuePress basically generate pages from Markdown files. So you can use it to generate documentation or blog sites easily.

You should create and write Markdown files, so that VuePress can convert them to different pages according to file structure.

Markdown Introduction

If you are a new learner and don’t know how to write Markdown, please read Markdown Introopen in new window and Markdown Demoopen in new window.

Markdown Config

VuePress introduce configuration for each Markdown page using Frontmatter.

Info

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

Markdown Extension

The Markdown content in VuePress will be parsed by markdown-itopen in new window, which supports syntax extensionsopen in new window via markdown-it plugins.

VuePress Enhancement

To enrich document writing, VuePress has extended Markdown syntax.

For these extensions, please read Markdown extensions in VuePressopen in new window.

Theme Enhancement

By using vuepress-plugin-md-enhanceopen in new window, the theme extends more Markdown syntax and provides richer writing functions.

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

Tabs

Apple

Code Tabs

npm i -D vuepress-theme-hope

Superscript and Subscript

19th H2O

Align

I am center

I am right align

Attrs

A word having id.

Footnote

This text has footnote[1].

Mark

You can mark important words .

Tasklist

Image Enhancement

Support setting color scheme and size

Chart

A Scatter Chart

Echarts

A line chart

Flowchart

Mermaid

Tex

∂r∂ωr(yωω)=(yωω){(log⁡y)r+∑i=1r(−1)ir⋯(r−i+1)(log⁡y)r−iωi} \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\}

Include files

Code Demo

A normal 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;
}

Stylize

Donate Mr.Hope a cup of coffee. Recommended

Playground

TS demo

Vue Playground

Vue Playground

Presentation

  1. This is footnote content ↩︎

Default footer
Copyright © 2023 Mr.Blue