mdBook icon indicating copy to clipboard operation
mdBook copied to clipboard

An option to highlight a "Note" and "Warning" using blockquote

Open thomas-k-cameron opened this issue 2 years ago • 2 comments

Problem

Github has recently announced that they are supporting highlight feature on their markdown.

I thought it would be nice if mdbook can support that out of the box. https://github.com/orgs/community/discussions/16925

Proposed Solution

e.g.

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

[!NOTE]
Highlights information that users should take into account, even when skimming.

[!TIP] Optional information to help a user be more successful.

[!IMPORTANT]
Crucial information necessary for users to succeed.

[!WARNING]
Critical content demanding immediate user attention due to potential risks.

[!CAUTION] Negative potential consequences of an action.

Notes

No response

thomas-k-cameron avatar Dec 23 '23 13:12 thomas-k-cameron

Note that mdBook already has class="warning": https://rust-lang.github.io/mdBook/format/mdbook.html#classwarning

Marcono1234 avatar Aug 04 '24 12:08 Marcono1234