Skip to main content

Markdown Enhance

团子日语August 25, 2024About 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 Intro and Markdown Demo.

Markdown Config

VuePress introduce configuration for each markdown page using Frontmatter.

Frontmatter

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 writing, VuePress has extended Markdown syntax.

For these extensions, please read Markdown extensions in VuePress.

Theme Enhancement

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

Code Tabs

npm
npm i -D vuepress-theme-hope

Tabs

apple

Apple

Footnote

This text has footnote[^first].

[^first]: This is footnote content

Include files

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

Tasklist

View Detail

Image Enhancement

Support setting color scheme and size.

Superscript and Subscript

19th H2O

Component

Mr.Hope

Where there is light, there is hope

Hint box and GFM alerts

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

Align

I am center

I am right align

Attrs

A word having id.

Mark

You can mark important words .

Spoiler

VuePress Theme Hope is powerful.

Stylize

Donate Mr.Hope a cup of coffee. Recommended

Reveal.js

Chart.js

ECharts

Flowchart

MarkMap

Mermaid

PlantUML

Code Demo

Playground

Kotlin Playground

Sandpack Playground

Vue Playground

app 有新版啦!
v0.0.2要去下载吗?