-
Notifications
You must be signed in to change notification settings - Fork 684
Closed
Description
Current Behavior
Currently, crates display the blockquote as it is in Markdown.
Expected Behavior
GitHub supports custom rendering for descriptions enclosed inside blockquote starting with [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], [!CAUTION] and this is widely used by many projects.
Syntax:
> [!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.Which looks like this once rendered:
These descriptions in Crates README can be rendered similarly to how it is shown in GitHub.
Check out https://github.com/orgs/community/discussions/16925 for more information.
Steps To Reproduce
- Go to a Crate using this kind of syntax in the README file i.e. https://crates.io/crates/tlrc.
- Navigate to the note or relevant section.
Environment
- Browser: Google Chrome Version 124.0.6367.60 (Official Build) (64-bit)
- OS: Fedora Linux 39 (Workstation Edition)
Anything else?
No response
Metadata
Metadata
Assignees
Labels
No labels

