Markdown

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 newcomer and don't know how to write Markdown, please read the following section.

Markdown Tutorial

Markdown Config

VuePress introduce configuration for each Markdown page using Frontmatter.

Info

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

Markdown Extension

The Markdown content in VuePress will be parsed by markdown-it, which supports syntax extensions via markdown-it plugins.

VuePress Enhancement

To enrich document content, VuePress extends standard Markdown syntax.

For these extended syntax, please see Built-in Markdown Features.

Theme Enhancement

By using vuepress-plugin-md-enhance, the theme extends more Markdown syntax and provides richer writing functions.

Hint box

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 caution 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

:::

::: caution Custom Title

A custom caution container

:::

::: details Custom Title

A custom details container

:::

• View Detail

Tabs

apple

Apple

banana

Banana

orange

Orange

• View Detail

Code Tabs

yarn

yarn add -D vuepress-theme-hope

npm

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

Attrs

A word having id.

• 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

Image Enhancement

Support setting color scheme and size

• View Detail

Component

Mr.Hope

---

Where there is light, there is hope

• View Detail

Chart

A Scatter Chart

• View Detail

Echarts

A line 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)\{(\log y{)}^r+\sum _{i=1}^r\frac{(-1{)}^{i}r\cdots (r-i+1)(\log y{)}^{r-i}}{{\omega }^i}\}$$

• View Detail

Include files

Tips

Hey how are you? 😄

• View Detail

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

• View Detail

Stylize

Donate Mr.Hope a cup of coffee. Recommended

• View Detail

Playground

TS demo

• View Detail

Kotlin Playground

Kotlin Playground

class Contact(val id: Int, var email: String)

fun main(args: Array<String>) {
    val contact = Contact(1, "mary@gmail.com")
    println(contact.id)
}

• View Detail

Vue Playground

Vue Playground

• View Detail

Presentation

• View Detail

---

1. This is footnote content ↩︎