[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 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.

[Wazbat]

I don't agree with using emojis instead of text as other suggest. I'd rather not have to go to google every time I want to type this if my device does not have a software emoji keyboard

[Crissov]

@Wazbat Since this is GFM, emoji shortcodes like :smile: are available as a workaround, although they – again – are English-only in many implementations. However, I’m not the only one who already mentioned ASCII art like <3 or classic emoticons like ;) and kaomoji like ^^ as a more international alternative.

[ljm12914]

Agreed strongly, from China.

[pboling]

@dipree said:

The idea is to take care of translation separately based on client preference.

This is an extremely bad idea. This isn't about client rendering. This is about forcing all authors of markdown on this platform to use English (and eventually all platforms, as whatever GFM implements will be adopted elsewhere). The feature is English-only, even if you translate on clients for readers.

PLEASE KILL THIS FEATURE.

[josevalim]

I don't believe the feature should be killed, it is an important feature (and clearly desired by many), but I agree with the concerns of it being English specific.

The original Markdown announcement said:

Readability, however, is emphasized above all else. A Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions.

With the current proposal, I can no longer write a document in Portuguese and use admonition blocks, without introducing English words such as TIP, CAUTION, etc. I'd say this goes directly against Markdown goals.

@dipree replied by saying (btw, thank you for leading this):

The idea is to take care of translation separately based on client preference.

The problem with this solution is that it brings complexity to Markdown rendering that does not exist today and it only solves half of the problem (rendering). It does not address the issue that the non-rendered Markdown document is now less expressive for non-English speakers.

@vassudanagunta already gave suggestions of how this could be tackled with Unicode, although such choice makes the document harder to write since you have to chase specific Unicode characters.

The most Markdown-like choice would be to choose specific characters for this, such as !!!:

> [!!!] Read this before continuing
>
> The flag `--danger` may wipe out your hard drive

One option, which has precedent in Markdown, is to rely on the number of characters to encode meaning, for example, ! means info, !! means warnings, and !!! means error. We could also explore different combinations of characters, such as !!! and ???.

I recognize it will be a challenge to find 5 different combinations with plain ASCII characters that are distinct and clear in meaning. We would need, at a bare minimum, to reduce the amount of styles to 3 or 4 (which would probably be enough anyway).

I am unsure what is the best answer here but we should at least discuss them. Enforcing English words in Markdown would be a regression. Thanks!

[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?

[Kirtishukla2004]

use html text with css

[SleazeStiKs]

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

[Puckky66]

ควย

[Puckky66]

ควยปั๊ก

[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.

[colin-p-hill]

I'm wondering how everyone feels about the fact that it would potentially break backwards compatibility?

The currently implemented syntax results in Markdown files which are backwards incompatible with other/older renderers, while the alternatives suggested here do not.

As others have pointed out, using the <blockquote> element for this contradicts the semantic meaning of the element. GitHub can alter its implementation to instead use a <div> in this special case, but this does not solve the problem for renderers which do not implement this extension. They will continue to render the block as a <blockquote>, per Commonmark semantics.

That is, by choosing this syntax, GitHub will cause other renderers to yield semantically incorrect output. This is backwards incompatibility and a step away from interoperability. Reusing any existing syntax for semantically incompatible purposes is definitionally a breaking change.

The generic directive syntax, being wholly new, does not have this semantic incompatibility problem. Renderers which support the directive syntax but not this specific plugin will be able to fall back to a default <div>-based presentation which displays the name, attributes, and content without any particular semantics. Renderers which do not support the directive syntax will just show the colons, which is ugly, but which does not break any established semantics.

(And if you don't buy the argument that colons littering the text does not constitute backward incompatibility, consider this alternative argument: By adopting a generic syntax for extensions, GitHub would break backwards compatibility exactly once and then be able to reuse the feature for all future extensions. Under the current design, we get a backwards incompatibility from special-casing the meaning of the > syntax, and future extensions may still need to introduce further incompatibilities.)

The code block syntax, following Obsidian's conventions, is a dubious but defensible middle ground. Renderers which don't support the extension will just use <pre> and <code>, which respectively indicate "a block of preformatted text, in which structure is represented by typographic conventions rather than by elements"¹ and "a fragment of computer code"². Markdown content technically meets those definitions, but it's still a questionable use of the elements, because the author of a Markdown document intends the Markdown code inside the block to be rendered, not presented as code.

Footnotes

1. https://html.spec.whatwg.org/multipage/grouping-content.html#the-pre-element ↩

2. https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-code-element ↩

[spenserblack]

GitHub just made a blog post about the >[!NOTE] syntax and added it to their docs, so I guess the current syntax is here to stay 🤷

[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.

[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]

Soft breaks are not part of GFM. They work in comments/issues/prs/releases, but not in readmes/gists.
Comments/etc do use GFM, but they also add more, such as these softbreaks.

[borekb]

Well, if GFM says that linebreaks are parsed as soft line breaks but GitHub does something different in issues/PRs, I'd then argue that issues/PRs are not GFM-compliant.

The GFM spec (https://github.github.com/gfm/) is written by GitHub so they have every opportunity to clarify the situation but they don't, so in my eyes their rendering of comments/issues/PRs is just a different dialect of Markdown and not GFM, though it's close.

(BTW I know this discussion is purely academic 😄.)

[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

[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

[0xGeN02]

Hi, does gitbook support this markdown feature? or any simmilar one

[infogulch]

Caution

Admonitions do not work inside <details> sections.

[!note]
This is not rendered as a note. 😞

<details>

> [!note]  
> This is not rendered as a note. 😞 

</details

[infogulch]

Tip

Repeating the same bug/feature request multiple times does not help. In the future, consider searching for your bug first.

[jjspace]

Obligatory updating of my list!

This is, unfortunately, intentional even though it's not documented

Update - 14 November 2023

• Prevent alerts from being nested within other elements.

As @pboling mentioned it's been discussed multiple times above but even though it's an obvious problem it's not been addressed. (linking for a record, no need to reply in every thread, don't spam)

• https://github.com/orgs/community/discussions/16925#discussioncomment-7618439
• https://github.com/orgs/community/discussions/16925#discussioncomment-7574895
• https://github.com/orgs/community/discussions/16925#discussioncomment-7868288
• https://github.com/orgs/community/discussions/16925#discussioncomment-7936248
• https://github.com/orgs/community/discussions/16925#discussioncomment-7888245
• https://github.com/orgs/community/discussions/16925#discussioncomment-8148855
• https://github.com/orgs/community/discussions/16925#discussioncomment-8383959
• https://github.com/orgs/community/discussions/16925#discussioncomment-8494315
• https://github.com/orgs/community/discussions/16925#discussioncomment-8542131
• https://github.com/orgs/community/discussions/16925#discussioncomment-8590818

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

[pboling]

Repeating the same bug/feature request multiple times does not help. In the future, consider searching for your bug first.

While this is possibly valid most of the time, in this case... when Github is pushing trashy, broken, features in the most harmful way to the most marginalized communities, I think it bears repeating, that it is broken. At the same time it does also serve to bury and obscure the very important discussion around should this feature be "fixed", or "canned" and replaced with something that is actually "good".

This is very important: ➡️ https://github.com/orgs/community/discussions/16925#discussioncomment-8729846

[opensrc0]

Check here https://github.com/opensrc0/fe-pilot?tab=readme-ov-file#usage
Click on See the list of components

Or try below code

Note

See the list of components

1. AutoFillOtp
2. CopyToClipboard
3. LiveLocation
4. LocateMe
5. PhoneBook
6. Scanner
7. Share
8. TextToSpeech
9. VoiceRecognition

[sinsukehlab]

@opensrc0 Wrong link destination
The correct link: https://github.com/opensrc0/fe-pilot?tab=readme-ov-file#usage

[opensrc0]

Check here https://github.com/opensrc0/fe-pilot?tab=readme-ov-file#usage
Click on See the list of components

Or try below code

Note

See the list of components

1. AutoFillOtp
2. CopyToClipboard
3. LiveLocation
4. LocateMe
5. PhoneBook
6. Scanner
7. Share
8. TextToSpeech
9. VoiceRecognition

[TWiStErRob]

That doesn't help putting it inside... 😞

IRL we would only highlight one or two sentences with admonition in the middle of multiple other paragraphs, lists etc. e.g. imagine wrapping the whole of OP in a details block.

[opensrc0]

I have just solve the problem to provide a list in the open close tab along with note. User can remove the note and they can use direct open close tabbuler type along with list.

[cdbdev]

Hello, is it known when this will be made official? :) Greetings

[chipzoller]

It's in the docs so I'd call that official.

[hkdobrev]

This is still not in the GFM spec https://github.github.com/gfm/

[sinsukehlab]

MathJax and Mermaid have not been reflected in the spec yet.
The spec doesn't specify some features that are supported in CommonMark but not in GitHub Flavored Markdown.

[nirname]

I miss question marks

> [!QUESTION] How to use
> Short guide

[d-kleine]

Good idea! 👍

[d-kleine]

I was actually a bit surprised that GitHub Alerts won't be displayed with the markdown preview in VS Code, just opened a feature request on that.

[smoonlee]

You can kinda get it working

But you need this extension -> https://marketplace.visualstudio.com/items?itemName=bierner.github-markdown-preview

[d-kleine]

But you need this extension -> https://marketplace.visualstudio.com/items?itemName=bierner.github-markdown-preview

Yeah, I also found another external (=Non-Microsoft) extension for that, see the request. What surprised me - and what I was asking for in this request - is that you cannot display GitHub Alerts in the preview with VS Code natively, without needing an extension for that. Also, the provided markdown extensions come from private developers, so they are not officially from Microsoft, even though both GitHub and VS Code are Microsoft products, and usually they are very well integrated into each other

[sinsukehlab]

That's not so surprising. GitHub has indeed been merged into Microsoft, but GitHub Flavored Markdown is different from the Markdown parsed in Microsoft Learn.
GitHub Flavored Markdown is not Markdown itself.

[MakePixelsWork]

Maybe one should be able to create ones own titles?

So... its not only like this:

But could also be this:

For instance... by updating the code to include your custom text

> [!WARNING:My own title]  
> This is a custome warning text.

[TWiStErRob]

+1 I was trying to do this until I realised it's not supported.

[!WARNING] My own title
This is a custome warning text.

[jjspace]

Ways to customize the text has been requested from the very beginning of this feature. Especially for use in non-english documents. Github has not seemed to be open to adding this functionality or embracing a syntax spec that already has it planned in.

• https://github.com/orgs/community/discussions/16925#discussioncomment-2787141 - The second comment in this whole discussion, been a request from the beginning
• https://github.com/orgs/community/discussions/16925#discussioncomment-2791993
• https://github.com/orgs/community/discussions/16925#discussioncomment-2794607
• https://github.com/orgs/community/discussions/16925#discussioncomment-4558009
• https://github.com/orgs/community/discussions/16925#discussioncomment-4561582
• https://github.com/orgs/community/discussions/16925#discussioncomment-6688422 - (I think this is just wishful thinking but an easy assumption based on the syntax they chose)
• https://github.com/orgs/community/discussions/16925#discussioncomment-8365099
• https://github.com/orgs/community/discussions/16925#discussioncomment-8457144

[d-kleine]

Hey everyone! Just wanted to let you know that I've submitted a feature request to integrate GitHub Alerts markdown directly into VS Code, on microsoft/vscode#209652. This enhancement proposal is currently under review for inclusion in the backlog, but it requires a minimum of 20 "thumbs-up" upvotes (👍) to progress further.

If you'd like to see this feature implemented as well, please lend your support by upvoting with 👍 there!

[d-kleine]

Maybe I did not understand it correctly, but didn't they suggest to apply it to GitHub repositories only?

          @alexr00 I'm more likely to say yes if we can keep this functionality isolated to the comments view. Should be possible by changing `markdownRenderer` to take an `github` option or something like that

Originally posted by @mjbvz in microsoft/vscode#209652 (comment)

[spenserblack]

but didn't they suggest to apply it to GitHub repositories only?

I may be mistaken, but my interpretation of the following comment was that it could be a setting:

Should be possible by changing markdownRenderer to take an github option or something like that

If so I don't have much of a problem with it, assuming it's not the default 🙂

[MakePixelsWork]

Its already part of the Projects system, so maybe they'll role it out on more parts of GitHub. Then again, its not supported by Markdown itself, so using it would only work on GitHub. Maybe Markdown developers could be contacted to allow usage?

[dserodio]

Maybe Markdown developers could be contacted to allow usage

There's no such thing as "Markdown developers", Markdown is a specification

[Crissov]

The only variant of Markdown that has a proper specification is Commonmark and GFM is build atop of that. There are no official extensions to CM yet and it is uncertain whether there ever will be, but certainly not before version 1.0.

https://talk.commonmark.org/t/github-is-beta-testing-their-own-admonition-syntax-we-should-weigh-in/4173/

[jmpp]

Hello there !
For the ones who use VSCode, you can adds a snippet configuration to use it more easily :

Simple steps here (no installation required) :

1. Open Command Palette : Cmd + Shift + P
2. Search for "snippets" and select Configure User Snippets
3. Choose in the list : markdown.json (Markdown)
4. Adds this to your configuration object :

// ...

"🟦 Highlights information that users should take into account, even when skimming." : {
  "prefix": "md:note",
  "body": [
    "> [!NOTE]",
    "> $1"
  ],
  "description": "Highlights information that users should take into account, even when skimming."
},
"🟩 Optional information to help a user be more successful." : {
  "prefix": "md:tip",
  "body": [
    "> [!TIP]",
    "> $1"
  ],
  "description": "Optional information to help a user be more successful."
},
"🟪 Crucial information necessary for users to succeed." : {
  "prefix": "md:important",
  "body": [
    "> [!IMPORTANT]",
    "> $1"
  ],
  "description": "Crucial information necessary for users to succeed."
},
"🟧 Critical content demanding immediate user attention due to potential risks." : {
  "prefix": "md:warning",
  "body": [
    "> [!WARNING]",
    "> $1",
  ],
  "description": "Critical content demanding immediate user attention due to potential risks."
},
"🟥 Negative potential consequences of an action." : {
  "prefix": "md:caution",
  "body": [
    "> [!CAUTION]",
    "> $1"
  ],
  "description": "Negative potential consequences of an action."
}

Then save and quit.

You can now type md: in a Markdown document and enable autocompletion to see the list.

Enjoy 🌞 !

[ashishagarwal2023]

Important

Hello

[texelh4ck]

It's very cool

[hwhsu1231]

Does it consider the localization scenario? For example:

> [!備註<NOTE>]  
> 標明使用者即使在瀏覽時也應該考慮的資訊。

I'm not sure whether the above example follows the correct syntax, but the point is to provide an identifier to tell GitHub how to render it if the string is not English.

[pboling]

It's worth noting that @dipree has on his profile:

I'm working for @github as a Product Manager focusing on making GitHub a more accessible place for all developers.

This feature (which is actually a bug) is the literal opposite of that claim, as long as we all assume that "accessible" and "all" mean what we all think those words mean.

[pboling]

It's worth noting here too, that GitHub evidentially has no interest in cross platform compatibility within Markdown, even as they charge ahead defining what everyone else will be forced to reverse-engineer to remain compatible, as the spec they publish for this purpose is out of date since 2019:
github/cmark-gfm#288

[adriangalilea]

So every single thing you create, it must first consider every language and condition before seeing the light of day?

That's surely is a way to not get anything done ever.

Most of the things we create and are fortunate enough to enjoy, are the product of innumerable iterations, and the first you need to do with something you are creating is letting people test it, not consider every possible user out there, that comes after.

And while I think that there's better possible implementations, and we should point that out, screaming colonialism, shows little respect for people trying to do good, and implies bad faith when it's likely their very best attempt.

[pboling]

So every single thing you create, it must first consider every language and condition before seeing the light of day?

No. Markdown, according to the only published spec that is current in any implementation, which is the CommonMark spec, is an explicitly non-alphabetic symbol language. You never have to consider any written human language with Markdown, because it contains zero "words", and that is the documented, explicit intent. There are several long discussions of this in this thread.

trying to do good

If you want to call "bad" "good", and "good" "bad", I can't stop you.

implies bad faith when it's likely their very best attempt.

This attempt of theirs was called out within 24 hours of being announced as having MAJOR flaws. All negative feedback was ignored, not even ackowledged, other than to gaslight, except for eventually they did half understand and listen about not overloading the <blockquote> html tag, despite still overloading the Markdown blockquote syntax. Go ahead read the discussion if you have a few days; I've been here since the beginning. Then come back and lecture me. All signs point to it being in bad faith.

[sinsukehlab]

@adriangalilea How many fallacies have you used in your comments?

[osslate]

Hi,

There seems to be an issue whereby admonitions aren't rendered when they're in a list.

The markup:

1.  Execute the following command to create a new workspace:
    ```console
    daytona create publicweb -r https://github.com/daytonaio/publicweb
    ```
    > [!TIP]  
    > Use the `--code` flag to automatically open the new workspace in Visual Studio Code.
    > 
    > __Example:__
    > ```console
    > daytona create publicweb -r https://github.com/daytonaio/publicweb --code
    > ```

[spenserblack]

Known (and apparently intentional) behavior: https://github.com/orgs/community/discussions/16925#discussioncomment-7618439

[jjspace]

As mentioned this is, unfortunately, intentional even though it's not documented It seems they did finally add documentation for it

Update - 14 November 2023

• Prevent alerts from being nested within other elements.

It's been discussed multiple times above so please continue to report this as an issue so github hopefully undoes this change. (linking for a record, no need to reply in every thread, don't spam)

• comment-7618439, comment-7574895, comment-7868288, comment-7936248, comment-7888245, comment-8148855, comment-8383959, comment-8494315, comment-8542131, comment-8590818, comment-8804836, this comment

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

[bewuethr]

From your documentation link:

Alerts cannot be nested within other elements.

[sinsukehlab]

Updated version: https://github.com/sinsukehlab/NOTE-test/blob/main/NOTE.md
I have found alerts accidentally more compatible with HTML tags than with other markdown elements. 😄

[peimanja]

When this will be available for GHES ?

[digitalmoksha]

I think everyone agrees that this is a useful feature, but there is a lot of negative feedback on the syntax. Is there a consensus what the syntax should be, that would be semantically correct, handle internationalization, and be considered good in the spirit of markdown?

[sinsukehlab]

Thanks for sharing interesting repos.
>>>>>>> has already been used to show conflicts with ======= and <<<<<<< in Git.

<<<<<<< my-resume
=======
>>>>>>> main

[RandomDSdevel]

Thanks for sharing interesting repos.

>>>>>>> has already been used to show conflicts with ======= and <<<<<<< in Git.

<<<<<<< my-resume
=======
>>>>>>> main

     Usually only within code blocks like how you have your example, but true. People sometimes forget to use those.

[digitalmoksha]

For me, it has to be in a code block to render properly - conflict syntax does not work in the raw markdown

---

<<<<<<< my-resume

main

[sinsukehlab]

The conflict syntax doesn't have to be rendered, it isn't considered to be rendered. As long as you use Git, using >>>>>>> otherwise is confusing when resolving conflicts.

[digitalmoksha]

Oh you're talking about doing conflict resolution on markdown files?

I suppose in some instances it might make you look twice, and you would need 5 levels of multiline block quotes embedded to match the conflict trailer.

But if that's a criteria, I would think markdown's Setext header syntax, which uses multiple equal signs, like

This is a header
================

would be just as confusing. 🤷