Container

Containers are a great way to mark important information and provide hints to users.

Tip

Rspress provides two styles of syntax, ::: syntax and GitHub Markdown Alerts syntax.

`:::` Syntax

You can use the ::: syntax to create custom containers and support custom titles. For example:

Rendered Result

Syntax

Note

This is a block of type note

Tip

This is a block of type tip

Info

This is a block of type info

Warning

This is a block of type warning

Danger

This is a block of type danger

Details

This is a block of type details

Custom Title

This is a block of Custom Title

Custom Title

This is a block of Custom Title

Warning

We recommend using the syntax :::tip Custom Title directly.

When using the ::: syntax in .mdx files and customizing headings with curly braces syntax, be aware of escaping.

:::tip\{title="Custom Title"}

This is a `block` of `Custom Title`

:::

You can use GitHub Markdown Alerts Syntax to create custom containers.

Rendered Result

Syntax

NOTE

This is a block of type note

TIP

This is a block of type tip

INFO

This is a block of type info

WARNING

This is a block of type warning

DANGER

This is a block of type danger

DETAILS

This is a block of type details