Hints

Callout blocks for notes, warnings, and other contextual messages. Also supports standard GitHub markdown alerts.

Syntax

{{%/* hint [info|success|warning|danger] */%}}
Markdown content
{{%/* /hint */%}}

Or using markdown alerts

> [!NOTE|TIP|IMPORTANT|WARNING|CAUTION]
> Markdown content

{{% hint %}} Default hint
Without a specified type. {{% /hint %}}

{{% hint info %}} Info
Use for supplementary information that helps the reader. {{% /hint %}}

{{% hint success %}} Success
Use to highlight a recommended approach or positive outcome. {{% /hint %}}

{{% hint warning %}} Warning
Use for important caveats or potential issues. {{% /hint %}}

{{% hint danger %}} Danger
Use for critical warnings about breaking changes or data loss. {{% /hint %}}

Standard GitHub markdown alert syntax is also supported:

Note

The theme requires Hugo extended edition for SCSS processing.

Tip

Set disablePathToLower = true in your config to preserve URL casing.

Important

The unsafe = true goldmark setting is required for Mermaid and KaTeX shortcodes.

Warning

Service worker support is experimental and may change in future releases.

Caution

Enabling BookPortableLinks = 'error' will fail the build if any markdown link targets are missing.