Alerts
GitHub style alerts look like this:
$ comrak -e alerts -t commonmark -t xml
Note
Highlights information that users should take into account, even when skimming.
Note
Highlights information that users should take into account, even when skimming.
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 -t commonmark -t xml
Note
Highlights information that users should take into account, even when skimming.
Note
Highlights information that users should take into account, even when skimming.
Highlights information that users should take into account, even when skimming.
Uppercase isn’t required:
$ comrak -e alerts -t commonmark -t xml
Note
Highlights information that users should take into account, even when skimming.
Note
Highlights information that users should take into account, even when skimming.
Highlights information that users should take into account, even when skimming.
Alerts can contain multiple blocks:
$ comrak -e alerts -t commonmark -t xml
Note
Highlights information that users should take into account, even when skimming.
Paragraph two.
Note
Highlights information that users should take into account, even when skimming.
Paragraph two.
Highlights information that users should take into account, even when skimming.
Paragraph two.
Other kinds of alerts:
$ comrak -e alerts -t commonmark -t xml
Tip
Optional information to help a user be more successful.
Tip
Optional information to help a user be more successful.
Optional information to help a user be more successful.
$ comrak -e alerts -t commonmark -t xml
Important
Crucial information necessary for users to succeed.
Important
Crucial information necessary for users to succeed.
Crucial information necessary for users to succeed.
$ comrak -e alerts -t commonmark -t xml
Warning
Critical content demanding immediate user attention due to potential risks.
Warning
Critical content demanding immediate user attention due to potential risks.
Critical content demanding immediate user attention due to potential risks.
$ comrak -e alerts -t commonmark -t xml
Caution
Negative potential consequences of an action.
Caution
Negative potential consequences of an action.
Negative potential consequences of an action.
A title can be specified to override the default title:
$ comrak -e alerts -t commonmark -t xml
Pay attention
Highlights information that users should take into account, even when skimming.
Pay attention
Highlights information that users should take into account, even when skimming.
Highlights information that users should take into account, even when skimming.
The title does not process markdown and is escaped:
$ comrak -e alerts -t commonmark -t xml
**Pay** attention <script>
Highlights information that users should take into account, even when skimming.
**Pay** attention <script>
Highlights information that users should take into account, even when skimming.
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 -t commonmark -t xml
-
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
-
Item one
Note
Highlights information that users should take into account, even when skimming.
Item one
Note
Highlights information that users should take into account, even when skimming.
-
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
Item one
Highlights information that users should take into account, even when skimming.