Rustdoc should support GitHub's note/warning blockquote syntax

tools and infrastructure
1

This is what it looks like: [Markdown] An option to highlight a "Note" and "Warning" using blockquote (Beta) · community · Discussion #16925 · GitHub

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
2

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.

3

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

4

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