Markdown Extension Examples

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

!!! This content will be wrapped in a custom block.

func Greetings() {
  fmt.Println("hi") 
}

Syntax Highlighting

Templ Syntax added in shiki@v1.10.0

This is the PR submitted to add Templ syntax support to Shiki.

package demos

templ hello(name string) {
  <div>Hello, { name }</div>
}

templ HelloDemo() {
  @hello("World!!!")
}

Examples

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.