title: “Callouts”

linkTitle: “Callouts”

This page is the migration regression catalog for callouts.

It covers:

  • Doks-documented callout contexts
  • Hugo-documented alert syntax that extends beyond Doks
  • local migration aliases handled by the current converter

Reference docs:

Doks catalog

Note

Doks-documented note callout.

> [!note] Note
> Doks-documented `note` callout.

Tip

Doks-documented tip callout.

> [!tip] Tip
> Doks-documented `tip` callout.

Caution

Doks-documented caution callout.

  • First caution item
  • Second caution item
> [!caution] Caution
> Doks-documented `caution` callout.
>
> - First caution item
> - Second caution item

Danger

Doks-documented danger callout.

npm create thulite@latest -- --template doks
> [!danger] Danger
> Doks-documented `danger` callout.
>
> ```bash
> npm create thulite@latest -- --template doks
> ```

Hugo alert catalog

Important

Hugo documents IMPORTANT, but Doks does not expose a separate important context. The migration currently maps it to Doks note.

> [!important] Important
> Hugo documents `IMPORTANT`, but Doks does not expose a separate `important` context.
> The migration currently maps it to Doks `note`.

Radiation hazard

Hugo documents optional fold signs and custom titles in alert designators. The migration currently preserves the custom title, ignores the fold sign, and maps warning to Doks caution.

> [!warning]+ Radiation hazard
> Hugo documents optional fold signs and custom titles in alert designators.
> The migration currently preserves the custom title, ignores the fold sign, and maps `warning` to Doks `caution`.

Local migration aliases

Info

Local alias mapped to Doks note.

> [!info] Info
> Local alias mapped to Doks `note`.

Question

Local alias mapped to Doks note with a help icon.

> [!question] Question
> Local alias mapped to Doks `note` with a help icon.

Thumbup

Local alias mapped to Doks note with a thumb-up icon.

> [!thumbup] Thumbup
> Local alias mapped to Doks `note` with a thumb-up icon.

Thumbdown

Local alias mapped to Doks caution with a thumb-down icon.

> [!thumbdown] Thumbdown
> Local alias mapped to Doks `caution` with a thumb-down icon.

Mapping reference

Source calloutDocumentation originCurrent migrated Doks context
noteDoks, Hugonote
tipDoks, Hugotip
cautionDoks, Hugocaution
dangerDoksdanger
importantHugonote
warningHugocaution
infolocal aliasnote
questionlocal aliasnote
thumbuplocal aliasnote
thumbdownlocal aliascaution