Replies: 310 comments 872 replies
-
|
How about 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. |
Beta Was this translation helpful? Give feedback.
-
|
@dipree can you please update the summary to mention that |
Beta Was this translation helpful? Give feedback.
-
|
Just use a 2x1 table in wiki pages:
|
Beta Was this translation helpful? Give feedback.
-
|
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. |
Beta Was this translation helpful? Give feedback.
-
|
Screenshots for @sinsukehlab - works at wiki:
|
Beta Was this translation helpful? Give feedback.
-
|
@krystian3w Yes, it also works at Wiki now. Update - 12 October 2023
|
Beta Was this translation helpful? Give feedback.
-
|
Thanks for this! Any way to customize the text? It would be very useful for non-English documents. |
Beta Was this translation helpful? Give feedback.
-
|
Why break it if we don't have to? Is there an advantage to the What bothers me about the repeated So thinking to the future, how would we add a "question" variant (for example)? Sticking with the syntax we already have would make it trivial to add new variants in the future that support custom text: |
Beta Was this translation helpful? Give feedback.
-
|
The point is to get rid of English keywords. The syntax does not have to be restricted to exclamation marks – four or five repetitions are a lot already. It is just that the current syntax uses one. |
Beta Was this translation helpful? Give feedback.
-
|
We should take into consideration that there are existing solutions outside of Github that already support the syntax that @laserlemon mentioned: 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! 🎉 |
Beta Was this translation helpful? Give feedback.
-
|
I stumbled upon this discussion while looking for a way to customize the label. Because I regularly miss a Currently, I'm doing: Note Example: This is an example... But it's really not great. So, being able to do |
Beta Was this translation helpful? Give feedback.
-
|
I'm currently running into this issue in a repo. It would be really nice if the label was customisable. |
Beta Was this translation helpful? Give feedback.
-
|
This is amazing 🔥 . This is now getting more features similar to AsciiDocs and AsciiDoctor 🎉 |
Beta Was this translation helpful? Give feedback.
-
|
great |
Beta Was this translation helpful? Give feedback.
-
|
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. |
Beta Was this translation helpful? Give feedback.
-
Same with reStructuredText, it has extensive support for admonitions both specific and generic ( |
Beta Was this translation helpful? Give feedback.
-
|
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 #. 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. |
Beta Was this translation helpful? Give feedback.
-
|
Here is the issue for the broken rST rendering: github/markup#1682 |
Beta Was this translation helpful? Give feedback.
-
|
Would love to see more callouts too for different use-cases. These 5 below might be good to start with! 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. |
Beta Was this translation helpful? Give feedback.
-
|
👍🏻 |
Beta Was this translation helpful? Give feedback.
-
@vassudanagunta AsciiDoctor supports locales for the admonition labels as well as icons |
Beta Was this translation helpful? Give feedback.
-
|
@toastal From your link it seems AsciiDoctor only supports icons in the HTML rendering, not in the source plain text. |
Beta Was this translation helpful? Give feedback.
-
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. |
Beta Was this translation helpful? Give feedback.
-
|
AsciiDoc รองรับชื่อภาษาไทย แต่ต้อง compile ใน terminal |
Beta Was this translation helpful? Give feedback.
-
|
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 |
Beta Was this translation helpful? Give feedback.
-
|
😑 |
Beta Was this translation helpful? Give feedback.
-
|
You say “backwards-compatible syntax”; I say “spec-breaking & semantic-breaking syntax” |
Beta Was this translation helpful? Give feedback.
-
|
How about Check for checked information?
|
Beta Was this translation helpful? Give feedback.
-
|
use html text with css |
Beta Was this translation helpful? Give feedback.
-
|
Tags like Important, Checked, Issue would be very useful. Having a tag for all states of progress |
Beta Was this translation helpful? Give feedback.
-
|
ควย |
Beta Was this translation helpful? Give feedback.
-
|
ควยปั๊ก |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
|
Why use the blockquote element? HTML Standard says:
|
Beta Was this translation helpful? Give feedback.
-
Agreed that the generated HTML should not use
But since we are defining new syntax, we get to define the semantics. We are specifically saying that 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. |
Beta Was this translation helpful? Give feedback.
-
|
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.
Firstly this violates the principle of least surprise - it's not totally clear why that renders a warning Secondly, how do I now quote someone that has actually said " 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. |
Beta Was this translation helpful? Give feedback.
-
|
The idea of GitHub-flavored Markdown changing the semantics of a |
Beta Was this translation helpful? Give feedback.
-
Please do us a favour and don't shamelessly advertise your stuff nobody really has interest in. |
Beta Was this translation helpful? Give feedback.
-
|
Could use a pipe symbol ( |
Beta Was this translation helpful? Give feedback.
-
|
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 This is how it would look: This would mean:
|
Beta Was this translation helpful? Give feedback.
-
|
GitHub just made a blog post about the |
Beta Was this translation helpful? Give feedback.
-
|
I also made a blog post. 👼 |
Beta Was this translation helpful? Give feedback.
-
|
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. |
Beta Was this translation helpful? Give feedback.
-
|
This syntax can be quite confusing, especially when writing in an IDE. |
Beta Was this translation helpful? Give feedback.
-
|
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 @LuudJanssen great plugin for remark! |
Beta Was this translation helpful? Give feedback.
-
|
Nice feature! Any way to use without blockquote though? |
Beta Was this translation helpful? Give feedback.
-
|
There is, yes! |
Beta Was this translation helpful? Give feedback.
-
|
More customization is always nice. What if you could specify the Github's Octoicon, color, and text? For example: to render the alert octicon (https://primer.github.io/octicons/alert-16) with a hex color of
|
Beta Was this translation helpful? Give feedback.
-
|
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 |
Beta Was this translation helpful? Give feedback.
-
|
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。 |
Beta Was this translation helpful? Give feedback.
-
|
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:
How it's rendered in readme:
|
Beta Was this translation helpful? Give feedback.
-
|
Soft breaks are not part of GFM. They work in comments/issues/prs/releases, but not in readmes/gists. |
Beta Was this translation helpful? Give feedback.
-
|
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 😄.) |
Beta Was this translation helpful? Give feedback.
-
|
CM deals with parsing. GFM inherits that property. You could argue that GFM is not compliant to CM, because it adds onto it. |
Beta Was this translation helpful? Give feedback.
-
|
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 ( 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 |
Beta Was this translation helpful? Give feedback.
-
|
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: |
Beta Was this translation helpful? Give feedback.
-
|
Instead, why not use highlight syntax for Add an letter and an extra Normal quote: |
Beta Was this translation helpful? Give feedback.
-
|
Would be cool if this can share the same syntax as Microsoft Docs "alerts" and Obsidian's "callouts". MS Docs format [1]: > [!NOTE]
> This is a note.
Obsidian format [2]: > [!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 |
Beta Was this translation helpful? Give feedback.
-
|
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. |
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
Colors, more colores, yes |
Beta Was this translation helpful? Give feedback.
-
|
I agree to everything |
Beta Was this translation helpful? Give feedback.
-
|
I think this design format would make for a more readable and visible readme file. |
Beta Was this translation helpful? Give feedback.
-
|
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.
|
Beta Was this translation helpful? Give feedback.
-
|
This syntax might hinder with what user actually wants to write The user will expect this to be rendered as following because
Also is Others have proposed great alternatives like Microsoft Docs Here is my take on the syntax. Suggestions are welcomed. |
Beta Was this translation helpful? Give feedback.
-
|
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. |
Beta Was this translation helpful? Give feedback.
-
|
i was thinking maybe |
Beta Was this translation helpful? Give feedback.
-
|
@dipree Do these work on GitHub Pages and with deploying locally with Jekyll using the |
Beta Was this translation helpful? Give feedback.
-
|
The answer is "no". The reason why has a lot to do with a wet fish slap. /s |
Beta Was this translation helpful? Give feedback.
-
|
For a workaround, here’s how GitHub Docs does it: https://github.com/github/docs/blob/main/src/content-render/liquid/spotlight.js The same thing can be achieved with |
Beta Was this translation helpful? Give feedback.
-
|
Hi! I've went ahead and created a Jekyll plugin that renders GitHub flavored admonitions! Try it out here: https://github.com/Helveg/jekyll-gfm-admonitions Building GitHub Pages with custom plugins can be quite involved, but I included detailed step-by-step instructions. It would be incredibly useful if you could let me know of any hiccups you encounter along the way. My plugin works both locally, and in a GHA-driven Jekyll build, with the |
Beta Was this translation helpful? Give feedback.
-
Nesting isn't working. 1. Something
> [!WARNING]
> Doesn't workResult:
|
Beta Was this translation helpful? Give feedback.
-
|
Any idea why they removed this functionality, or how we could request for them to add it back? Not being able to nest callouts is kind of limiting. |
Beta Was this translation helpful? Give feedback.
-
|
You can't fix a dumpster fire unless you put out the flames. The flames are the feature in this case. |
Beta Was this translation helpful? Give feedback.
-
The feature doesn't work well with Prettier as well: prettier/prettier#16454 |
Beta Was this translation helpful? Give feedback.
-
|
This feature is a poison pill for any project that uses any tools outside GitHub, and even a lot of the tools inside GitHub. It will never be part of the Markdown spec, and implementations in many other projects will be contested and contentious, because of how obviously terrible this particular implementation of annotations is. |
Beta Was this translation helpful? Give feedback.
-
|
Doxygen already supports this syntax: https://www.doxygen.nl/manual/markdown.html#mddox_github_alerts |
Beta Was this translation helpful? Give feedback.
-
|
Hi, I am wondering why Caution seems more "dangerous" than Warning, while I believe they should (in general) be reversed...? cf. (among others)
I'm really reluctant to point this out as I guess people should have already considered this, but I could not find any by skimming this long threads so... just in case. |
Beta Was this translation helpful? Give feedback.
-
|
This feature was not well considered or well researched. We need to keep making noise about the many, many problems with this feature, and perhaps other GitHub staff will take notice someday. Don't gaslight yourself into thinking the problem is you. It isn't you. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks a lot for your kind words. I originally noticed this issue when a cloud-based wiki service I'm using (esa.io) implemented some alerts mimicing the ones in here: https://docs.esa.io/posts/505 . I at first thought I would just tell them there, but I thought perhaps it's better I make a comment here as the impact would be much greater. |
Beta Was this translation helpful? Give feedback.
-
|
Hi, can you add option to rename the titles of these blockquotes? For example if I want to write them in any other language for different language users English words are not perfect fit. For instance of Spanish: |
Beta Was this translation helpful? Give feedback.
-
|
I think they saw this feature as low hanging fruit, which they could implement with CSS tricks, based on reusing the existing parser turning the If you look at @dipree's profile's README, he changed it about a year ago. It used to highlight the fact that "tiny wins, little changes" were his team's primary focus. This being a "big change, hard thing" is way outside the scope, and unless we make A LOT MORE noise, it is unlikely to ever be noticed. I've copied what his profile used to say, which is highly relevant to this feature, and also screenshotted it in case it finds a memory hole:
|
Beta Was this translation helpful? Give feedback.
-
|
I have to add that it is the pinnacle of irony that he changed it to say that his focus is now on making GitHub a more accessible place for all developers (emphasis mine, and certainly not his), when this feature does exactly the opposite, for non-English speaking developers, and for disabled developers using assistive technologies (as I've documented heavily previously). |
Beta Was this translation helpful? Give feedback.
-
|
This whole feature is pretty broken to be honest. In addition to not being able to change the language, you also cannot indent these at all (pretty terrible looking if your admonition applies to a nested bullet point). If you only care about rendering on GitHub, might be better to just make your own admonition with emojis. https://www.markdownguide.org/hacks/#admonitions If you need it to work outside of GitHub consider using an image instead of an emoji. GitHub should also probably being using the mkdocs syntax for admonitions instead of re-inventing the wheel. That's the syntax supported by any markdown renderers that currently support admonitions. |
Beta Was this translation helpful? Give feedback.
-
|
@ReenigneArcher Yeah, I am barely using those kind of adminitions. Barely, just barely. 😟🥺😢😭 |
Beta Was this translation helpful? Give feedback.
-
|
Being able to rename the headings would enable the "good code vs bad code" pattern for guideline documentation |
Beta Was this translation helpful? Give feedback.
-
|
I wish this worked while indented :( Note This is a working note! |
Beta Was this translation helpful? Give feedback.
-
|
I am glad it doesn't because this is a terrible implementation, and the better it works the more things it will infect. This is a poison pill feature. Read up on some of the above threads, but most specifically this one about the nesting: Do not use this feature! |
Beta Was this translation helpful? Give feedback.
-
|
Hey, four or more spaces of indentation composes indented code blocks in Markdown (CommonMark). ExamplesNote This is indented with one space. Note This is indented with two spaces. Note This is indented with three spaces. |
Beta Was this translation helpful? Give feedback.
-
|
@ryanwinter @sinsukehlab is saying the same thing I am, but you gave him a thumb up, and me a thumb down? Your contrbution to the discussion will only elevate the discussion if we keep it focused on what needs to change. Supporting indents in the current iteration is not what needs to change. Did you read any of the posts that came before yours? Perhaps you can help us with this disaster of a feature, since you work at Microsoft? |
Beta Was this translation helpful? Give feedback.
-
|
Please support Obsidian syntax to set custom title, thanks (https://help.obsidian.md/Editing+and+formatting/Callouts#Change+the+title) |
Beta Was this translation helpful? Give feedback.
-
|
It won't happen, unless GitHub pays attention to us (we have no evidence of that). See: https://github.com/orgs/community/discussions/16925#discussioncomment-10458963 |
Beta Was this translation helpful? Give feedback.
-
|
This doesn't work if nested in bullet points. Example> [!NOTE]
> Test note
> [!IMPORTANT]
> Test important
- Test bullet
> [!NOTE]
> Test note
- Test bullet2
> [!IMPORTANT]
> Test importantNote Test note Important Test important
|
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
This is, unfortunately, intentional
It's been discussed multiple times above and is clearly something that should work (and people want) if the feature is thought out and implemented fully |
Beta Was this translation helpful? Give feedback.
-
|
Look at GitHub making us do their job for free! Thanks @jjspace for the commitment to "exposing bull shit when you see it". |
Beta Was this translation helpful? Give feedback.
-
|
Hi Important Requirements:
is it possible to move |
Beta Was this translation helpful? Give feedback.
-
|
This feature is a dumpster fire. It is intentionally broken. Fom directly above...
|
Beta Was this translation helpful? Give feedback.
-
|
At least this aspect is a question about lists in blockquotes with a solution independent of admonitions: > [!IMPORTANT]
> Requirements:
>
> - XXX
> - YYY
>
> Move Tab to left:
>
> - ZZZ
> - QQQrenders as Important Requirements:
Move Tab to left:
|
Beta Was this translation helpful? Give feedback.
-
|
@bewuethr Thanks ! |
Beta Was this translation helpful? Give feedback.
-
|
This is totally independent of admonitions or blockquotes. - XXX
lazy indent
- YYY
- XXX
left
- YYY
left
|
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
This feature is a dumpster fire. It is intentionally broken. Fom directly above...
|
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
Nothing is fine. This is a poison pill feature. |
Beta Was this translation helpful? Give feedback.
-
Test casesSpace variationsTip no space Tip space before open bracket
Case variationTip uppercase Tip title case Tip lowercase Tip mixed case
Exclamation variationTip single prefix
Text variationTip standard keyword
|
Beta Was this translation helpful? Give feedback.
-
|
these are woking fine in github but when we create npm package and on package homepage it does not render as expected. how can we make shich support both places? here is one example of npm homepage |
Beta Was this translation helpful? Give feedback.
-
|
Stay away from this feature if you want your Markdown to work everywhere. There is no evidence that GitHub will be putting in effort to make this a community standard, nor does it seem they will continue improving it on their own platform. The list of bugs is long, and the list of external Markdown tools that don't support is always growing. |
Beta Was this translation helpful? Give feedback.
-
|
@pboling the problem is, npm is a subsidiary of GitHub. They should at least be consistent across their own platforms. |
Beta Was this translation helpful? Give feedback.
-
|
@csandman It is true that npm is now owned by GitHub, which is a subsidiary of Microsoft, but it was founded independently and then acquired by GitHub. They don't have to support the poison pill 'alerts' feature, while GitHub themselves can't implement it properly. |
Beta Was this translation helpful? Give feedback.
-
Sure they don't have to, I'm just saying they should be consistent. |
Beta Was this translation helpful? Give feedback.
-
|
Can the API (https://api.github.com/markdown) to convert Markdown to HTML be updated to include these admonitions? Currently, it ignores them and pretends it's regular text (e.g., |
Beta Was this translation helpful? Give feedback.
-
|
Stay away from this feature if you want your Markdown to work everywhere. There is no evidence that GitHub will be putting in effort to make this a community standard, nor does it seem they will continue improving it on their own platform. The list of bugs is long, and the list of external Markdown tools that don't support is always growing. |
Beta Was this translation helpful? Give feedback.
-
|
highlights are not working inside collapse
Note a note! |
Beta Was this translation helpful? Give feedback.
-
|
This is, unfortunately, intentional
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. (linking for a record, no need to reply in every thread, don't spam) |
Beta Was this translation helpful? Give feedback.
-
|
It seems that customising the admonition title works only on VSCode:
But it does not work on GitHub: Preview here:
|
Beta Was this translation helpful? Give feedback.
-
|
I'm not sure which extension is rendering that, but if I were you, I'd be inclined to file a bug against it (assuming it's trying to be compatible w/ GitHub, which made it clear that this wasn't the way they intended the feature to work). |
Beta Was this translation helpful? Give feedback.
-
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:
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
Update - 14 November 2023
[!TIP]and[!CAUTION].**Note**isn't supported any longer.Update - 12 October 2023
Update - 28 July 2023
Thank you all once again for providing a ton of feedback. Few more changes based on that:
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:
divinstead of ablockquote.IMPORTANT.[!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.
This input:
Becomes:
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.
Beta Was this translation helpful? Give feedback.
All reactions