Rustdoc should support GitHub's note/warning blockquote syntax

This is what it looks like: https://github.com/orgs/community/discussions/16925

The syntax is now supported by GitHub.

UPDATE 1: There is a discussion in CommonMark about this: ⚠️ GitHub is beta testing their own Admonition syntax. We should weigh in - Extensions - CommonMark Discussion

UPDATE 2: It seems Docusaurus aren't too fond of this: GFM like admonitions/callouts · Issue #7471 · facebook/docusaurus · GitHub

4 Likes

My first question: Is Rustdoc using GFM? If not, why grab this syntax? I'd rather see efforts to getting it into CommonMark before just picking it up wholesale.

I agree something with markdown syntax would be nice, but the decision was made to just offer an HTML class for this:

Related: ⚠️ GitHub is beta testing their own Admonition syntax. We should weigh in - Extensions - CommonMark Discussion

Which also leads to the same GitHub discussion.

1 Like

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.