close
Rspress
  • English

      • 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 note callout

      Tip

      This is a tip callout

      Info

      This is an info callout

      Warning

      This is a warning callout

      Danger

      This is a danger callout

      Details

      This is a details callout

      Custom Title

      This is a callout with a custom title

      Custom Title

      This is a callout with a custom title

      Notes

      • Container types must be lowercase. Use :::tip, :::warning, :::caution, etc. Capitalized types like :::Tip or :::Warning will not be recognized.

      • When using the ::: syntax in .mdx files and customizing headings with curly braces syntax, remember to escape the braces. We therefore recommend using the syntax :::tip Custom Title directly.

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

      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