Asides

Asides are callout boxes that draw attention to important information. Each type has a distinct color and icon.

Types

Note

General information the reader should be aware of.

Syntax:

:::note
Your content here.
:::

Tip

Best practices and helpful suggestions.

Caution

Potential issues the reader should watch out for.

Danger

Critical warnings about destructive or irreversible actions.

Custom Titles

Add a custom title in square brackets after the type:

Syntax:

:::tip[Pro Tip]
Your content here.
:::

Rich Content

Asides support full markdown inside:

Best Practices

• Limit to one or two asides per section to avoid overwhelming readers
• Match the aside type to the importance of the message
• Keep content concise and actionable
• Use custom titles when the default label isn't descriptive enough