[Markdown] An option to highlight a "Note" and "Warning" using blockquote (Beta) #16925

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.

Note The first line must be exactly as shown below. The first letter is case sensitive. The second line can contain your content.

How about **Important** for very important information? Could be useful in combination with Issue forms to get the attention of the user so that they know what to provide.

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.

Agreed. The fact that it detects what appears to be a normal paragraph and infers its meaning is already not great, but this implementation makes it very English-centric.

Leave a Comment