GFM like admonitions/callouts
See original GitHub issueHave you read the Contributing Guidelines on issues?
- I have read the Contributing Guidelines on issues.
Motivation
Github is experimenting with adding admonition/callout support to GFM. When and if the solution stabilises it would be nice to make docusaurus compatible with this solution as this would make it easier to reuse markdown content that was initially written for github. Another point for it is to lower the learning curve as GFM is an industry standard.
From this comment I can see that there are known issues with current admonition implementation and there are plans to fork it #6246.
Two examples of this feature:
Note At time of creation GFM callouts is an experimental feature and is discussed here
Warning GFM callouts currently only support
Note
|Warning
variations while docusaurus docs mention support fornote
|tip
|info
|caution
|danger
Self-service
- I’d be willing to do some initial work on this proposal myself.
Issue Analytics
- State:
- Created a year ago
- Reactions:3
- Comments:7
Top Results From Across the Web
Obsidian on Twitter: "Kudos to javalent for developing the ...
Callout (aka Admonition) is now available as part of core • Indentation Guides to make your lists look nice • Basic table rendering...
Read more >Obsidian - Callouts Tutorial (Built-in Admonitions) - YouTube
Admonitions are now a core functionality in Obsidian. Check it out!
Read more >GitLab Flavored Markdown (GLFM)
When you enter text in the GitLab UI, GitLab assumes the text is in the Markdown language. The text is rendered with a...
Read more >remark-directive - unified
::hr{.red} A :i[lovely] language know as :abbr[HTML]{title="HyperText Markup Language"}. ::: ... Note: This is sometimes called admonitions, callouts, etc.
Read more >Configuration - MkDocs
You can specify another path for it by using the -f / --config-file option (see mkdocs build --help ). As a minimum, this...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Ah, I get it—makes sense. Yes, MDN does work on the HAST, see https://github.com/mdn/yari/blob/9fdc643900719ea54ad415119998d73d0784cb6b/markdown/m2h/handlers/index.js#L80-L99 (And their contributing guidelines also mentioned that you can use HTML to get the same effect—I can’t find it right now)
There is a ton of feedback for GitHub to do something else: https://github.com/github/feedback/discussions/16925
Also, feature parity, if possible, would be super buggy: GH has been introducing a bunch of broken things recently, e.g: https://nschloe.github.io/2022/05/20/math-on-github.html