Documentation

Callouts

Callouts highlight information that deserves attention without interrupting the main flow of the document.

ctrl alt doc provides four built-in callout types:

Note #

Use :::note for general information.

Use :::tip for useful advice or recommendations.

Use :::warning when something deserves caution.

Use :::danger for potentially destructive or serious situations.

You can provide a custom title by adding it in square brackets.

The syntax is :::type[Title].

Callouts can contain normal Markdown content.

Callout types and their labels and icons are configured in ctrlaltdoc.config.ts.

This means a project can customise the callout presentation without changing the documentation syntax.