[Markdown] An option to highlight a "Note" and "Warning" using blockquote (Beta)

[dipree]

Alerts are an extension of Markdown used to emphasize critical information. On GitHub, they are displayed with distinctive colors and icons to indicate the importance of the content.

An example of all five types:

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

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

Here is how they are displayed:

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Update - 14 December 2023

• Changelog: New Markdown extension: Alerts provide distinctive styling for significant content
• Updated documentation

Update - 14 November 2023

• Add support for [!TIP] and [!CAUTION].
• Add support for alerts in Markdown files on GitHub Mobile apps. (pending a mobile app update)
• Add support for various Markdown extensions such as Math rendering, relative links, task lists, animated image player and footnotes.
• Prevent alerts from being nested within other elements.
• The initial syntax using e.g. **Note** isn't supported any longer.

Update - 12 October 2023

• Fix bug where alerts aren't rendered in Markdown file previews
• Add support for Wikis
• Fix various issues with nested blockquotes

Update - 28 July 2023

Thank you all once again for providing a ton of feedback. Few more changes based on that:

• Support for soft line break in Markdown files.
• Visual improvements to stand out better in content and render appropriately with different font-sizes (comments vs. docs)
• Minor bug fixes

Update - 26 July 2023

Thanks for all the comments, we are working on a handful of fixes. One of them is to support soft line breaks in Markdown documents, so it will work the same in comments versus docs.

Update - 21 July 2023

We've made several improvements in response to your feedback:

• The output will now render as a div instead of a blockquote.
• The text color has been changed to primary from the previous muted version.
• We've tightened our parsing rules to prevent conflicts with other Markdown or HTML on the allowed list.
• Consequently, a line break following the title is now required.
• We've introduced a new alert type IMPORTANT.
• A new syntax, [!NOTE], has been added, which will gradually replace the old one. However, the old syntax will continue to work for some time.

Thanks to all for your valuable input on this topic!

Initial - 10 May 2022

To better highlight and separate certain information from the rest in your documentation on GitHub, we now render a special and accessible note or warning blockquote in Markdown documents. We are using the existing syntax for blockquote and bold text.

Note
The first line must be exactly as shown below. The first letter is case sensitive. The second line can contain your content.

This input:

> **Note**
> This is a note

> **Warning**
> This is a warning

Becomes:

Note
This is a note

Warning
This is a warning

Let us know what you think and how this helps you provide better documentation. Please note that this is a beta feature that might be subject to change.

🐳

[Andre601]

How about **Important** for very important information?
Could be useful in combination with Issue forms to get the attention of the user so that they know what to provide.

Edit: Also, to add to this, maybe extend this behaviour to other parts such as headers in block quotes? I like to use headers because of their larger font size, but right now are they not included in this.

[jsoref]

@dipree can you please update the summary to mention that preview and mobile aren't yet implemented so that people don't have to read through 183 comments / 479 replies to discover this?

[MarcoSteinke]

@sinsukehlab

Just use a 2x1 table in wiki pages:

💡 Tip
I am a tip

⚠️ Warning
Do not read this.

[krystian3w]

Important

@RahulVerma989 (https://github.com/orgs/community/discussions/16925#discussioncomment-7024899) Changelog indicates that you can change the tables to quoting with a header at wiki if you do not nest them.

[krystian3w]

Screenshots for @sinsukehlab - works at wiki:

[sinsukehlab]

@krystian3w Yes, it also works at Wiki now.

Update - 12 October 2023

• Fix bug where alerts aren't rendered in Markdown file previews
• Add support for Wikis
• Fix various issues with nested blockquotes

[laymonage]

Thanks for this!

Any way to customize the text? It would be very useful for non-English documents.

[Swivelgames]

We should take into consideration that there are existing solutions outside of Github that already support the syntax that @laserlemon mentioned:

> [!QUESTION] Consider this…
> How do we invalidate the cache?

Right now, Markdown files with this syntax are broken when viewed in Github.

It would be great to see this custom text feature. Long awaited! 🎉

[ByScripts]

I stumbled upon this discussion while looking for a way to customize the label.

Because I regularly miss a > [!EXAMPLE] alert.

Currently, I'm doing:

Note

Example:

This is an example...

But it's really not great.

So, being able to do > [!NOTE] Example would be a great addition.

[smileyhead]

I'm currently running into this issue in a repo. It would be really nice if the label was customisable.

[Srushanth]

Yes! I agree. It would be nice to have [!EXAMPLE] or it would be even better if I can use something like below!

> [!<EMOJI>] Custom note
> Message to the reader

[Snailedlt]

You could take it a step further and support ultra simple admonitions with no title triggered by any paragraph whose first character is one of the special symbols:

ℹ️ This is an info message.

⚠️ Consider this a warning.

❌ This is a very serious danger message.

✅ This is an affirmation message.

Why not do this but with the commonmark syntax, and replace the emojis with simpler characters that look like them?

:::i "Info"
This is the content of an info message
:::

:::! "Warning"
This is the content of a warning message
:::

:::x "Danger"
This is the content of a severe danger message
:::

:::v "Affirmation"
This is the content of an affirmation message
:::

:::? "Tip"
This is the content of a tip message
:::

This way it's easily recognizable while not relying on english words. It looks like what it represents and it's easier to write than emojis.

The syntax here is:
:::type "title"
Content
:::

[eddiejaoude]

This is amazing 🔥 . This is now getting more features similar to AsciiDocs and AsciiDoctor 🎉

[Anlen02]

great

[toastal]

Except that AsciiDoc has had native admonitions since forever (in the standard, not a GitHub-flavored AsciiDoc fork) but GitHub has never supported styling them at all.

[xmo-odoo]

Except that AsciiDoc has had native admonitions since forever (in the standard, not a GitHub-flavored AsciiDoc fork) but GitHub has never supported styling them at all.

Same with reStructuredText, it has extensive support for admonitions both specific and generic (admonition) in the baseline language, but that gets rendered as essentially garbage.

[nk9]

It turns out you can use this new admonitions hack in reStructuredText as well by just using the 4-space block quote syntax. And you can even indent it using the pull-quote directive.

#. List item

   .. code:: bash

      Do something

   .. pull-quote::
      **Warning**
      
      **NB:** Something to be aware of

Still, I don't understand why GitHub still refuses to allow these with the built-in admonition directives in these languages.

[flying-sheep]

Here is the issue for the broken rST rendering: github/markup#1682

[JonDouglas]

Would love to see more callouts too for different use-cases. These 5 below might be good to start with!

https://docs.microsoft.com/en-us/contribute/markdown-reference#alerts-note-tip-important-caution-warning

I'm not sure if this is only for documentation, but I would use it in general issues and other places supporting markdown. I would especially like to see one that is red in terms of "caution". That might be especially useful with enforcing a code of conduct when you've already provided a warning and would be generally helpful with RFCs(request for comments) about any major signs of caution.

[n1ckwhite]

👍🏻

[toastal]

Support any language

@vassudanagunta AsciiDoctor supports locales for the admonition labels

https://github.com/asciidoctor/asciidoctor/tree/main/data/locale

as well as icons

https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/#enable-admonition-icons

[vassudanagunta]

@toastal From your link it seems AsciiDoctor only supports icons in the HTML rendering, not in the source plain text.

[toastal]

From your link it seems AsciiDoctor only supports icons in the HTML rendering, not in the source plain text.

I don't know that you’d want icons in your plaintext as it could be ambiguous at times. Also given how many open bugs there are for CLI tools to remove the emoji from the terminal (it really does look out of place), maybe plaintext is the place to keep emojis out. 🤷

But maybe it could work …and has the advantage of being (somewhat) language agnostic. Some symbols like stop signs are more universal.

[toastal]

AsciiDoc รองรับชื่อภาษาไทย แต่ต้อง compile ใน terminal

[BenLorantfy]

Clever backwards compatible syntax 👍

what about changing the colour of the block quote line to blue / yellow?

if you wanted to go further, you could add a background colour as well that’s a lighter shade of the corresponding colour

[007532234]

😑

[toastal]

You say “backwards-compatible syntax”; I say “spec-breaking & semantic-breaking syntax”

[eduardogerentklein]

How about Check for checked information?

[vassudanagunta]

Doesn't look very good in the plain text:

> **Check**
> This is OK

How about the plain text looking as natural as the rendered version:

> ✅ Check
> This is OK

It gracefully degrades when rendered under generic Markdown:

✅ Check
This is OK

And:

✅ Use any title in any language

This stays true to the language-agnostic spirit of Markdown.

More variations here and here

[Kirtishukla2004]

use html text with css

[SleazeStiKs]

Tags like Important, Checked, Issue would be very useful. Having a tag for all states of progress

[Hezethegamer]

Check
This is OK

[YusukeHirao]

Why use the blockquote element?
The content is not always that is quoted from another source.

HTML Standard says:

The blockquote element represents a section that is quoted from another source.

[vassudanagunta]

@YusukeHirao:

HTML Standard says:

The blockquote element represents a section that is quoted from another source.

Agreed that the generated HTML should not use <blockquote>. GitHub can easily have it rendered as a <div> with a warning class.

@tom-sherman:

I don't like the idea of overloading the blockquote semantics to mean something more than a quote.

But since we are defining new syntax, we get to define the semantics. We are specifically saying that > **Warning** is the syntax for a semantic Warning admonition. > in all other cases has block quotation semantics.

I looked at the HTML GitHub is rendering it with, and they are not using a div+class as they should:

<blockquote>
<p><span class="color-fg-attention"><svg>...</svg>Warning</span><br>
This is a warning</p>
</blockquote>

This should be fixed. It not only violates HTML semantics, it's going to make it less accessible. I'm not an expert, but there is probably a proper ARIA way to do this.

[tom-sherman]

I find the conversation around markdown grammar interesting and I think when you consider the design of the markdown syntax it backs up my point even more.

We are specifically saying that > **Warning** is the syntax for a semantic Warning admonition. > in all other cases has block quotation semantics.

Firstly this violates the principle of least surprise - it's not totally clear why that renders a warning aside or callout and not a blockquoted "Warning" in bold.

Secondly, how do I now quote someone that has actually said "** Warning"? It would require escaping. Going a step further, how do I quote someone else's warning callout? Overloading the blockquote markdown introduces new decisions that need to be made, this is bad design overall.

And finally, the proposed syntax changes GithHub Flavored Markdown in such a way that it adds more context to the grammar. I believe this to be the root cause of the two symptoms above.

[toastal]

The idea of GitHub-flavored Markdown changing the semantics of a <blockquote> is hilarious and also bad. This would mean your Markdown isn't supported elsewhere: CommonMark, GitLab-flavored Markdown, etc. Locking yourself into just GitHub will bite you in the future. This should not be done. > is for blockquotes and blockquotes quote content.

[Andre601]

Please Star this repo : https://github.com/shu6h4m/MicroSoft_Activator

Please do us a favour and don't shamelessly advertise your stuff nobody really has interest in.

[benjie]

Could use a pipe symbol (|) instead of a greater than (>) for admonitions, blockquote does not seem ideal.

[Murderlon]

Hi, I like the idea but I would like to propose alternative syntax.

GitHub Flavored Markdown is a superset of CommonMark and thus ideally it stays close to that if possible. The generic directives proposal for CM is already used in the ecosystem, take for instance remark-directive or how it's implemented in the very popular Docusaurus and VuePress.

This is how it would look:

:::note
This is a note
:::

:::warning
This is a warning
:::

This would mean:

• GH markdown is more compatible with other solutions.
• You aren't introducing yet another non-standard markdown feature
• It is more future proof. Directives are generic, future features could be added without inventing new syntax every time.

[meduzen]

I also made a blog post. 👼

[LuudJanssen]

We created a remark plugin to turn GitHub's syntax into the directive syntax: remark-github-admonitions-to-directives

This helped us reuse markdown files in Docusaurus docs.

[H0llyW00dzZ]

This syntax can be quite confusing, especially when writing in an IDE.

[codingluke]

I think it is great to have the Githup callout syntax as proposed in the issue an now already available. And I also think that the two "callout" and "directives" are only in competition for admonition, not for custom directives.

Why not support directives in addition too? 💪

As all static site generators like astro (starlight), docusaurus, vitepress, marp, sli.dev... are supporting directives, this would be a grate drop in feature :) IMHO I like directives more, as there is no > on every new line.

@LuudJanssen great plugin for remark!

[TurnOffNOD]

Hi, I like the idea but I would like to propose alternative syntax.

GitHub Flavored Markdown is a superset of CommonMark and thus ideally it stays close to that if possible. The generic directives proposal for CM is already used in the ecosystem, take for instance remark-directive or how it's implemented in the very popular Docusaurus and VuePress.

This is how it would look:

:::note
This is a note
:::

Maybe add a 1-line tip (alert, notice, warning etc.) feature to this syntax will be better, as this:
code:

:::TIP some tip with quoting code `code`:::

or

:::!TIP some tip with quoting code `code`:::

or

:::[!TIP] some tip with quoting code `code`:::

render as:

[Tess314]

Nice feature! Any way to use without blockquote though?

[pboling]

There is, yes!
The directives proposal!

[Andrew6rant]

More customization is always nice. What if you could specify the Github's Octoicon, color, and text?

For example:

> **alert#9a6700;Warning**
> This is a warning

to render the alert octicon (https://primer.github.io/octicons/alert-16) with a hex color of #9a6700 and a text of "Warning":

Warning
This is a warning

[DerekNonGeneric]

As @pboling pointed out earlier, I would be wary of providing Markdown authors with syntax specifically to accommodate their Octicon symbol name as it may contribute to vendor lock-in. I do, though, wonder whether this feature is only expected to offer users a couple of options (the fundamentals) or whether we should be expecting more choices in the future? If we have one admonition for warnings, we should be given at least one more for the danger zone/error prone/high severity callout content as well.

With the two current choices of note and warning, I doubt additional syntax for specifying particular Octicon symbol names would really be necessary (or even preferable). In the current rendition of this beta feature, the GitHub Web UI may have implemented these callouts using Octicons, but with the limited subset we were given — only a couple of key choices — I think we can probably do better here.

[NB-Dragon]

I don't think it is a good choice.

But opening up a space for users to pick the best color would be better.

Too rich colors can cause visual fatigue for users。

[Tyrrrz]

Seems like...

> **Note**
> Text

...is currently rendered on the same line in readme files, instead of two separate lines like it does here in discussion comments:

How it's rendered here:

Note
Text

How it's rendered in readme:

[wooorm]

CM deals with parsing. GFM inherits that property.
Breaks (and mentions, gemoji, much much more) do not happen when parsing, they are added later by transforming the HTML.
The recent addition of math is similar: it also transforms the HTML (I believe this to be bad and that is should happen in the parser).
I definitely agree there is a lot of room for improvement of explaining this situation.

You could argue that GFM is not compliant to CM, because it adds onto it.
I understand this point, that comments are not GFM compliant, as similar: I instead see comments as GFM compliant, and CM compliant, but adding more things.

[borekb]

I have to admit that I'm not as sure about the technical details or even terms like you are, but in laymen terms, if comments/issues/PRs started rendering two trailing spaces (line··) or a backslash (line\) as a soft line break, I'd say that they violate CommonMark / GFM. In my eyes, this is not an "addition" like the things you mentioned, this is a change in behavior.

But ok, it's the way it is, in the past I've spent quite some time browsing the "Writing on GitHub" section of their docs to find definitive answers but it's often quite fuzzy 🤷‍♂️.

I'm not entirely confident in their implementation either, for example, this new "Note" / "Warning" feature has a lot of strange rendering bugs like #123 not recognized within it, like if they didn't have tests around this or something which is very hard to believe.

[Andre601]

There isn't really a reason why markdown in issues, Pull requests and discussions can't be GFM. It's just a slightly modified one.

And why it behaves so differently in terms of line breaks should be obvious here: Not everyone who files an issue or posts a discussion knows the ins and outs of Markdown, let alone GFM, so not having to deal with that two spaces thing for line-breaks makes it easier for those new people.

We could argue about the semantics, backwards compatibility, etc. of GFM with CommonMark until the heat-death of the universe. In the end does it not matter here. When adding new stuff is GitHub most likely thinking about how it is the easiest and most convenient to use for the end-users, which may not always be programmers or people with vast CommonMark knowledge.

I mean some other features of GFM are barely known such as that when writing a HEX colour inside an inline-code block, it renders a small icon in that colour: #aabbcc

[see7e]

The behaviour of:

Seems like...

> **Note**
> Text

...is currently rendered on the same line in readme files, instead of two separate lines like it does here in discussion comments:

How it's rendered here:

Note
Text

How it's rendered in readme:

Has changed:

[ADTC]

@see7e Don't rely on these features too much. They're great when they work, but they're beta. And basically abandoned from having any further development, sadly.

[nathan130200]

Instead, why not use highlight syntax for >I> will provide Important stuff. >W> -> Warning, >N> for note.

Add an letter and an extra > before to create contextual quote.

Normal quote: > this is normal quote!
warning: >W> this is text for warning quote
etc.

[lishid]

Would be cool if this can share the same syntax as Microsoft Docs "alerts" and Obsidian's "callouts".

MS Docs format [1]:
Supports types: NOTE, TIP, IMPORTANT, CAUTION, and WARNING.

> [!NOTE]
> This is a note. 

Obsidian format [2]:
Supported types: note, abstract, summary, tldr, info, todo, tip, hint, important, success, check, done, question, help, faq, warning, caution, attention, failure, fail, missing, danger, error, bug, example, quote, cite. Types are inspired from Material for MkDocs.

> [!Note] Callout can have an _optional_ title
> Callouts can also be nested:
> > [!Hint]- You can also create foldable callouts with `+` or `-`
> > This is hidden until unfolded.

[1]: https://docs.microsoft.com/en-us/contribute/markdown-reference#alerts-note-tip-important-caution-warning
[2]: https://help.obsidian.md/How+to/Use+callouts

[DerekNonGeneric]

I had never heard of Obsidian before seeing it mentioned here. Other than Obsidian Publish, are other services using Obsidian-Flavored Markdown? I would be curious to know how portable the syntax is.

[klaudiagrz]

NOTE, TIP, and CAUTION types would be awesome to have! 😍

[HotCakeX]

Colors, more colores, yes

[okoyemmeso]

I agree to everything

[christopher3810]

I think this design format would make for a more readable and visible readme file.
Hopefully this will become true in the near future.

[ahmadawais]

This is awesome! 🚀

Would be great if we're offered more customization and standard syntax for these though. That'll allow many tools to auto support this.

Note
This is awesome!

Warning
Going to start using it everywhere.

[PROxZIMA]

This syntax might hinder with what user actually wants to write

> **Note**
> This is a note

> **Warning**
> This is a warning

The user will expect this to be rendered as following because **text** is bold syntax.

Note
This is a note

Warning
This is a warning

Also is blockquote necessary here? It's more like overloading its basic functionality.

Others have proposed great alternatives like Microsoft Docs alerts and Obsidian's callouts in #16925 (comment) and remark-directive in #16925 (comment)

Here is my take on the syntax. Suggestions are welcomed.

--[!Note]
This is the subtext for Note
until line break, `<br>` occurs

--[!Warning] 
This is the subtext for Warning
until line break, `<br>` occurs

--[!Alert] 
This is the subtext for Alert
until line break, `<br>` occurs

[pboling]

There is a Markdown RFC for a standard that would support this already. Not sure why they didn't use it, but it would be better to collaborate with the Markdown spec than make GFM even more of a monster.
More: #16925 (comment)

[goyalyashpal]

i was thinking maybe (i) and /!\ can be used in some way too? to make it more strong and unambiguous - syntax wise

[pengzhenghao]

The syntax is actually very hard to remember.. I search this post everytime I want to type in > [!WARNING]

[jasonkarns]

Where do we submit issues against the docs? GitHub's current docs refer to these as "Alerts". https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

But all the other (previously existing, I might add) markdown parsers and extensions refer to them as "Admonitions".

At the very least, the github docs should include the word Admonitions in their docs so that searches can correctly identify these concepts as the same thing.

[pboling]

Nothing should be done to further advertise this feature.
It has been abandoned by GitHub, and the bugs will not be fixed.
Ideally it would be removed from the docs.
It has no redeeming qualities, and is a slap in the face to the established principles of Markdown (a recent thread, there have been so many.)

[hdub-tech]

For future reference and for the sake of answering @jasonkarns 's question... those docs can be found in the github/docs repo. That exact section can be found HERE (commit link is main as of this writing).

[jasonkarns]

I'm just another user, sharing my frustration that the admonitions break when nested in a list.

https://github.com/orgs/community/discussions/16925?sort=new#discussioncomment-12043928

[pboling]

That's not even a bug. It used to work, and they intentionally broke it.

https://github.com/orgs/community/discussions/16925#discussioncomment-12043928

[T3sT3ro]

unacceptable and infuriating...

[konosubakonoakua]

not working in <details></details> pairs:

[!CAUTION]
not working in <details></details> pairs:

also in a indent format:

• indent next line

  [!CAUTION]
  Oops

[jjspace]

This is, unfortunately, intentional

Update - 14 November 2023

• Prevent alerts from being nested within other elements.

It's been discussed multiple times above and has frustrated many people. Maybe Github will finally undo this change but I wouldn't get your hopes up. _{(just linking for a record)}

• comment-7618439, comment-7574895, comment-7868288, comment-7936248, comment-7888245, comment-8148855, comment-8383959, comment-8494315, comment-8542131, comment-8590818, comment-8804836, comment-9156825, comment-9538837, comment-10195289, comment-10575676, comment-10620802, comment-10949202, comment-11812784, comment-12029106, comment-12491256

[kingthorin]

Is this why it isn't working nicely in issue forms?

[pboling]

That is a different issue. Bottom line is this is an extremely buggy feature that will not be fixed, and should not be fixed.

It needs to be entirely redesigned from the ground up.

[zry98]

Any way to use it on Github Pages?

[jsoref]

There are third party components that support it: https://github.com/Helveg/jekyll-gfm-admonitions

[pH-7]

This is excellent. You can also add code into the message 👌

[krystian3w]

Also with syntax highlight:

Note

HighlightsAdblock Plus/uBO/AdGuard:

example.com##p:has(a[href])

[TurnOffNOD]

Hi, can this be used in one line? Just as follows:

> [!TIP] some tip with quoting code `code`

and render the "tip marker" (and other markers) the same line with the content? As screenshot shown below:

[TurnOffNOD]

This feature appears to have been abandoned, so I think it is unlikely to get any more bug fixes or improvements. Many people pointed out how terrible it was/is from the beginning, but these fundamental issues were always ignored. It remains English-only, and non-customizable.

This feature appears to have been abandoned, so I think it is unlikely to get any more bug fixes or improvements. Many people pointed out how terrible it was/is from the beginning, but these fundamental issues were always ignored. It remains English-only, and non-customizable.

What does it mean by "This feature"? Does it mean the "icon and content in 1-line" feature that is asked by me, or does it mean the entire "An option to highlight sth." feature?

[pboling]

I mean this feature, as implemented, to support a kind of "admonition" syntax, appears to have been abandoned, and by that I mean that I doubt it will get more updates, or fixes, or changes. It is my hope that the feature, which is still technically in "beta", will be removed entirely, and replaced by a new syntax that is actually good, from a technical, and a human, standpoint.

[TurnOffNOD]

I mean this feature, as implemented, to support a kind of "admonition" syntax, appears to have been abandoned, and by that I mean that I doubt it will get more updates, or fixes, or changes. It is my hope that the feature, which is still technically in "beta", will be removed entirely, and replaced by a new syntax that is actually good, from a technical, and a human, standpoint.

Oh, I see. Is your "actually good" syntax means #16925 (comment) ?

[Crissov]

Several alternative, better, language-neutral syntaxes have been proposed in this topic and elsewhere. Some tried to stay as compatible with Github’s overly basic approach as possible, e.g. just repeat the exclamation mark ! for higher admonition levels and the current keywords become the caption.

[Rudra-G-23]

Important

Kaggle Markdown Support

[tats-u]

Why is the admonition title whose color is red Caution, not Danger?

I believe manuals of many (physical) products use all of Caution, Warning, and Danger.

From: https://www.muirgraphics.com/2016/08/difference-life-death-choosing-right-safety-signal-words/

From: http://www.overheadlifting.org/understanding-safety-signs-and-overhead-lifting-equipment-hazards/

Also I believe Caution is less serious than Warning.

[tats-u]

They're just background. The accent colors matter more.
I think it's off-topic.

[tristanls-tbp]

It is unfortunate that the GitHub criticality of Caution and Warning is in reverse order to how most of the world views their criticality.

[joshenders]

It is unfortunate that the GitHub criticality of Caution and Warning is in reverse order to how most of the world views their criticality.

Does "most of the world" actually feel this way or does this presentation only apply to:

the construction, installation, operation, inspection, and maintenance of hand-operated and power-driven overhead and gantry cranes that have a top-running single-girder or multiple-girder bridge, with one or more top-running trolley hoists used for vertical lifting and lowering of freely suspended, unguided loads consisting of equipment and materials.

And more specifically, in America where ASME B30.2 - 2022 may apply.

If we're going to be pedantic about software, let's at least be correct.

[tristanls-tbp]

@joshenders , it seems like you found another example of warning being more critical than caution. Do you have a documented counterexample of a community or a profession where caution is more critical than a warning?

[ruukr8080]

This is exactly the feature!!
I needed!
thx u! thx u!

[ErfanRMN]

I love this feature!!!

[ruukr8080]

I have long earnestly desired!!!!!!!!!!!

[pH-7]

Happy time!

[sinsukehlab]

There is a similar feature in GitHub Docs, parsed by the following TypeScript Execute script:
https://github.com/github/docs/blob/main/src/frame/components/ui/Alert/Alert.tsx

[sairus7]

Is this specific to English language?

[pboling]

Yes. There is a chance that it will be improved to allow custom admonitions (meaning support for any language). CC @martinwoodward

[code-y-furrybot]

None of these seem to work within <details></details collapsibles 🤷

Collapsible

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

[!TIP]
Optional information to help a user be more successful.

[!IMPORTANT]
Crucial information necessary for users to succeed.

[!WARNING]
Critical content demanding immediate user attention due to potential risks.

[!CAUTION]
Negative potential consequences of an action.

[jjspace]

This is, unfortunately, intentional

Update - 14 November 2023

• Prevent alerts from being nested within other elements.

It's been discussed multiple times above and has frustrated many people. Maybe Github will finally undo this change but it seems extremely unlikely at this point _{(just linking for a record)}

• comment-7618439, comment-7574895, comment-7868288, comment-7936248, comment-7888245, comment-8148855, comment-8383959, comment-8494315, comment-8542131, comment-8590818, comment-8804836, comment-9156825, comment-9538837, comment-10195289, comment-10575676, comment-10620802, comment-10949202, comment-11812784, comment-12029106, comment-12491256, comment-12649051

@sinsukehlab has made a really nice example page that shows the ways notes render (and don't render) for various situations including "nesting" example if you wanna see a more thorough example

[Kochise]

None of these seem to work within <details></details collapsibles 🤷

Indeed...

[recursivezero]

VS code is using this feature now in v 1.106 but github does not have any timeline .

[slorber]

Not really.

The don't plan to support the GitHub syntax by default in VS Code markdown previews: microsoft/vscode#209652 (comment)

[pboling]

This is not a trash can. Oh wait, maybe it is. Carry on. 🤣