Skip to content

Markdown Extension Examples

This page demonstrates some of the built-in markdown extensions provided by VitePress.

Syntax Highlighting

VitePress provides Syntax Highlighting powered by Shiki, with additional features like line-highlighting:

Input

md
```js{4}
export default {
  data () {
    return {
      msg: 'Highlighted!'
    }
  }
}
```

Output

js
export default {
  data () {
    return {
      msg: 'Highlighted!'
    }
  }
}

Custom Containers

Input

md
::: info
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: details
This is a details block.
:::

Output

INFO

This is an info box.

TIP

This is a tip.

WARNING

This is a warning.

DANGER

This is a dangerous warning.

Details

This is a details block.

Badge

Info default

Tip ^1.9.0

Warming beta

Danger caution

UML

Input

md
```mermaid
flowchart LR
  Start --> Stop
```

Output

Input

md
```mermaid
graph TD
A[开始] --> B(处理)
B --> C{结果}
C -->|成功| D[结束]
C -->|失败| B
```

Output

More

Check out the documentation for the full list of markdown extensions.