8000 Proposal: GitHub Special Markdown Blocks · Issue #518 · kivikakk/comrak · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
Proposal: GitHub Special Markdown Blocks #518
Closed
@Arteiii

Description

@Arteiii

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

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0