⚠️ GitHub is beta testing their own Admonition syntax. We should weigh in

That being said, a conformant extension to CommonMark could adopt the base syntax:

> [!]
> A block not rendered necessarily as a quote but a generic admonition, alert or aside. 

It would be up to configuration and stylesheets, which keywords or symbols/emojis would be recognized after the exclamation mark, and how – e.g. color and symbol – this would be rendered.


  • reStructured Text (rST) and Docutils have these Admonitions: attention, caution, danger, error, hint, important, note, tip, warning – see Sphinx themes for instance
  • AsciiDoc and DocBook support the following Admonitions: note, tip, warning, caution, important
  • Bootstrap knows these Alerts: success, danger, warning, info; primary, secondary; light, dark
  • Bikeshed, used for W3C specifications, by default recognizes Issue, Advisement, Assertion and Note.
Symbol Github Atlassian Docusaurus Obsidian MDN Quarto MS/Microsoft Learn Google dev Paligo
:information_source: note info note info, todo note note important notice
:question::grey_question: question, help, faq
:exclamation::grey_exclamation: (warning / caution) (warning) info important note caution important
:warning: warning note warning warning, caution, attention warning warning warning warning warning; caution; danger
:stop_sign::no_entry::no_entry_sign: caution warning
:white_check_mark::heavy_check_mark::ballot_box_with_check: tip success, check, done success
:negative_squared_cross_mark::heavy_multiplication_x::x: failure, fail, missing caution
:speech_balloon: :thought_balloon: :right_anger_bubble: :speaking_head: important
:bulb: tip tip tip tip tip
:fire: danger tip, hint, important
:memo::pencil2: note, seealso note
:spiral_notepad::clipboard: abstract, summary, tldr
:zap: danger, error
:beetle::lady_beetle: bug
:test_tube: example
quote, cite
:bell:
:arrow_heading_up:
:construction: caution
:star: note
:magic_wand::sparkles: tip
callout
3 Likes