Markdown Extension Examples

NOTE

Highlights information that users should take into account, even when skimming.

TIP

Optional information to help a user be more successful.

IMPORTANT

Crucial information necessary for users to succeed.

WARNING

Critical content demanding immediate user attention due to potential risks.

CAUTION

Negative potential consequences of an action.

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

Heading 1

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

Heading 2

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

Heading 2

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

Heading 3

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

Heading 4

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

Heading 5

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

Heading 6

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

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

Output

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

Custom Containers

Input

::: 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.

More

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