question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

GFM like admonitions/callouts

See original GitHub issue

Have you 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 for note | tip | info | caution | danger

Self-service

  • I’d be willing to do some initial work on this proposal myself.

Issue Analytics

  • State:open
  • Created a year ago
  • Reactions:3
  • Comments:7

github_iconTop GitHub Comments

2reactions
Josh-Cenacommented, May 24, 2022

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)

2reactions
wooormcommented, May 24, 2022

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

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found