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

Feature Request: GitHub Alerts #143

Open
orchetect opened this issue Sep 23, 2024 · 3 comments
Open

Feature Request: GitHub Alerts #143

orchetect opened this issue Sep 23, 2024 · 3 comments

Comments

@orchetect
Copy link

orchetect commented Sep 23, 2024

In May 2024 GitHub revised their callout syntax (they call them Alerts).

It would be lovely to gain support for these in QLMarkdown.

(Various 3rd-party Markdown editors now support it including Typora.)

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.

@setanarut
Copy link
Contributor

setanarut commented Sep 23, 2024

Why only English? They could just put an icon without text.
https://github.com/orgs/community/discussions/16925#discussioncomment-10458963

If this feature is to be added to QLMarkdown, a CSS trick for other languages ​​is required.

@orchetect
Copy link
Author

orchetect commented Sep 23, 2024

People have been expressing a desire for localized versions of these for years (as seen by the many comments on that GitHub issue thread). There's been no movement from GitHub staff to implement any thus far. Perhaps they will in future, but all we have are English alerts for now.

I would certainly understand any hesitancy of implementing the behaviour in QLMarkdown with that considered. I'm only suggesting it so as to closer match QLMarkdown's rendering to GitHub's rendering, as-is.

Perhaps we would be able to meet in the middle, like you say. If QLMarkdown rendered them with the colored line and the icon, it could just omit the text label. That way no localization is necessary, even though it won't explicitly mirror GitHub's rendering.

@setanarut
Copy link
Contributor

I just wrote this as a suggestion. @sbarex may want to add it as an extra feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants