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

Default hint
Without a specified type.

Info
Use for supplementary information that helps the reader.

Success
Use to highlight a recommended approach or positive outcome.

Warning
Use for important caveats or potential issues.

Danger
Use for critical warnings about breaking changes or data loss.

Standard GitHub markdown alert syntax is also supported:

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

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

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

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