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

[Typst Universe] Support for GitHub-flavored Markdown Callouts/Alerts in READMEs #501

Open
jdpieck opened this issue Dec 3, 2024 · 0 comments
Labels
feature request New feature or request. universe About Typst Universe

Comments

@jdpieck
Copy link

jdpieck commented Dec 3, 2024

Description

GitHub has support for a Markdown extension called Alerts. These alerts allow for documentation information to be displayed with distinctive colors and icons to indicate the significance of the content.

Seeing as these are already supported by GitHub and are already being used by package developers (myself included), having this capability in Typst Universe would allow for a higher level of parity across platforms for package documentation.

Use Case

The types of alerts being requested would follow the list as provided on GitHub Docs.

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

This displays as...

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.

Thank you for your consideration!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or request. universe About Typst Universe
Projects
None yet
Development

No branches or pull requests

2 participants