Admonition

The admonition shortcode creates visually distinct callout boxes to highlight important information in your content. It supports five different types, each with its own styling and icon.

Usage

GO
1
2
3
{{< admonition type="note" title="Custom Title" >}}
Your content here. go is supported!
{{< /admonition >}}

Parameters

ParameterRequiredDefaultDescription
typeNo"note"The admonition type: note, tip, info, warning, or danger
titleNoCapitalized type nameCustom title for the admonition box
Table: Admonition Parameters

Available Types

Note (💡)

Use for general information or helpful notes.

GO
1
2
3
{{< admonition type="note" >}}
This is a note admonition with default styling.
{{< /admonition >}}

Colors: Blue border (#2196f3), light blue background (#e3f2fd)


Tip (✅)

Use for helpful tips or best practices.

GO
1
2
3
{{< admonition type="tip" title="Pro Tip" >}}
Here's a useful tip to improve your workflow!
{{< /admonition >}}

Colors: Green border (#4caf50), light green background (#e8f5e9)


Info (â„šī¸)

Use for informational content.

GO
1
2
3
{{< admonition type="info" >}}
Additional information that might be useful.
{{< /admonition >}}

Colors: Cyan border (#00acc1), light cyan background (#e0f7fa)


Warning (âš ī¸)

Use for warnings or cautionary information.

GO
1
2
3
{{< admonition type="warning" title="Be Careful!" >}}
This action might have unintended consequences.
{{< /admonition >}}

Colors: Orange border (#ff9800), light orange background (#fff3e0)


Danger (❌)

Use for critical warnings or errors.

GO
1
2
3
{{< admonition type="danger" title="Critical" >}}
This is a dangerous operation that could cause data loss.
{{< /admonition >}}

Colors: Red border (#f44336), light red background (#ffebee)


Examples

Basic Note

💡 Note
This uses all default values - type “note” and title “Note”.

Custom Title

âš ī¸ Important Update
The API endpoint has changed. Please update your code.

With go Content

✅ Tip

You can use bold, italic, and even code inside admonitions.

  • Bullet points work too
  • Multiple paragraphs are supported