Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New feature: Support GitHub markdown Alert styles #405

Open
rydmike opened this issue Nov 13, 2024 · 1 comment
Open

New feature: Support GitHub markdown Alert styles #405

rydmike opened this issue Nov 13, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@rydmike
Copy link
Contributor

rydmike commented Nov 13, 2024

For some time GitHub has supported Alerts in markdown with this style:

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

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

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.

Please consider adding them as an alternative to the current Callouts

Pub.dev has started to support the GitHub Alerts markdown too. It makes using them convenient when they are supported in both GitHub and pub markdown docs. It would further simplify things if docs.page supported them too.

@Ehesp
Copy link
Member

Ehesp commented Nov 13, 2024

Good call!

@Ehesp Ehesp added the enhancement New feature or request label Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants