Alerts

GitHub style alerts look like this:

$ comrak -e alerts
> [!NOTE]
> Highlights information that users should take into account, even when skimming.

It shouldn’t matter if there’s a soft break or hard break after the [!NOTE]:

$ comrak -e alerts
> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

Uppercase isn’t required:

$ comrak -e alerts
> [!note]
> Highlights information that users should take into account, even when skimming.

Alerts can contain multiple blocks:

$ comrak -e alerts
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
>
> Paragraph two.

Other kinds of alerts:

$ comrak -e alerts
> [!TIP]
> Optional information to help a user be more successful.
$ comrak -e alerts
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
$ comrak -e alerts
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
$ comrak -e alerts
> [!CAUTION]
> Negative potential consequences of an action.

A title can be specified to override the default title:

$ comrak -e alerts
> [!NOTE] Pay attention
> Highlights information that users should take into account, even when skimming.

The title does not process markdown and is escaped:

$ comrak -e alerts
> [!NOTE] **Pay** attention <script>
> Highlights information that users should take into account, even when skimming.

They work in the same places as a normal blockquote would, such as in a list item:

$ comrak -e alerts
- Item one

  > [!NOTE]
  > Highlights information that users should take into account, even when skimming.