Skip to content

Support for Github Alerts in README's #296

@deathaxe

Description

@deathaxe

How about rendering Github Alerts in READMEs?

Some packages make use of them, and they look pretty bare (or broken) on packages.sublimetext.io

Examples:

> [!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.

Possible extension: https://github.com/bent10/marked-extensions/tree/main/packages/alert

Metadata

Metadata

Assignees

No one assigned

    Labels

    websiteIssues related to the website

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions