6.8 KiB
| title | icon | order | category | tag | ||
|---|---|---|---|---|---|---|
| Markdown Enhance | fab fa-markdown | 2 |
|
|
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.
::: important 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.
Hint box
::: v-pre
Safely use {{ variable }} in Markdown.
:::
::: info Custom Title
A custom information container with code, link.
const a = 1;
:::
::: 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
:::
Tabs
::: tabs#fruit
@tab apple
Apple
@tab banana
Banana
@tab orange
Orange
:::
Code Tabs
::: code-tabs#shell
@tab pnpm
pnpm add -D vuepress-theme-hope
@tab yarn
yarn add -D vuepress-theme-hope
@tab:active npm
npm i -D vuepress-theme-hope
:::
Superscript and Subscript
19^th^ H~2~O
Align
::: center
I am center
:::
::: right
I am right align
:::
Attrs
A word{#word} having id.
Footnote
This text has footnote1.
Mark
You can mark ==important words== .
Tasklist
- Plan A
- Plan B
Image Enhancement
Support setting color scheme and size
Component
title: Mr.Hope
desc: Where there is light, there is hope
logo: https://mister-hope.com/logo.svg
link: https://mister-hope.com
background: rgba(253, 230, 138, 0.15)
Include files
Stylize
Donate Mr.Hope a cup of coffee. Recommended
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\}