Call-outs¶
Callouts, also called admonitions, offer a way to bring specific information to the attention of the reader. This can be a warning, a tip, or additional background information.
In Markdown, there are several names for call-outs that look the same. The general format is as follows, with !quote indicating the type of call-out:
Neutral information¶
note, todo
Use a NOTE to inform the reader of something even when skimming a page.
-
NOTE is supported on GitHub, GitLab, and Microsoft.
abstract, summary, tldr
Use an ABSTRACT, SUMMARY, or TLDR to give a brief overview of the page.
info
Use an INFO to provide more background information or links to further reading.
quote, cite
Use a QUOTE or CITE to include a copy of somewhere else.
example
Use an EXAMPLE to clarify a concept.
question, help, faq
Use a QUESTION, HELP, or FAQ to answer a question the reader typically has at this point.
Positive consequences¶
tip, hint, important
Use a TIP to help a reader benefit from potential added value, or to explore a new direction.
Use an IMPORTANT note to share crucial information for the reader to be succesful.
-
TIP and IMPORTANT are supported on GitHub, GitLab, and Microsoft, but have different looks there. A TIP looks more optional.
success, check, done
Use SUCCESS, CHECK, or DONE to highlight a positive outcome.
Negative consequences¶
Warnings and cautions look the same in Obsidian and MkDocs. In other systems, a caution is treated like a danger.
warning, caution, attention
Use a WARNING, CAUTION or ATTENTION note to advise the reader to act carefully (i.e., exercise care), to avoid errors or mistakes.
-
WARNING and CAUTION are supported on GitHub, GitLab, and Microsoft, but have different looks there. A CAUTION looks more severe.
danger, error
Use DANGER to alert the reader for danger, harm, or severe consequences that exist.
bug
Use a BUG to highlight an error.
fail, failure, missing
Use a FAIL, FAILURE, or MISSING to highlight a negative outcome.