Skip to content

Consider aligning alert syntax with GitHub / GitLab #258

@serkonda7

Description

@serkonda7

Quarkdown has extended markdown to support alerts wiki.

GitHub and GitLab also have such extensions but with a different syntax:

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

wiki links:

Proposal

I would propose to change the syntax to align with these two services as they have a huge userbase and most people probably be used to their syntax and could get confused when using quarkdown or have to remember two different syntaxes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions