Closed
Description
GitHub Markdown supports special blocks like these:
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.
The original discussion can be found here: GitHub Community Discussion #16925.
Adding support for these special blocks would improve compatibility with GitHub READMEs and other documentation files.
Specifically, tools like cargo crates would greatly benefit from this feature,
as discussed here: rust-lang/crates.io Discussion #8506
Metadata
Metadata
Assignees
Labels
No labels