Container
Containers are a great way to mark important information and provide hints to users.
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:
This is a block of type note
This is a block of type tip
This is a block of type info
This is a block of type warning
This is a block of type danger
Details
This is a block of type details
This is a block of Custom Title
This is a block of Custom Title
-
Container types must be lowercase. Use
:::tip,:::warning,:::caution, etc. Capitalized types like:::Tipor:::Warningwill not be recognized. -
When using the
:::syntax in.mdxfiles and customizing headings with curly braces syntax, remember to escape the braces. We therefore recommend using the syntax:::tip Custom Titledirectly.
:::tip\{title="Custom Title"}
This is a `block` of `Custom Title`
:::GitHub Markdown alerts syntax
You can use GitHub Markdown Alerts Syntax to create custom containers.
This is a block of type note
This is a block of type tip
This is a block of type info
This is a block of type warning
This is a block of type danger
DETAILS
This is a block of type details