Github markdown alerts support #1884
Replies: 3 comments 3 replies
-
Thanks for the suggestion @prescottprue! I'm a bit hesitant about this one. GitHub's syntax is very nonstandard (and already changed once recently) and as far as I know, is not supported anywhere else. (Not even npm, which is part of the same company 😅). I think I would wait and see if the GitHub syntax becomes more common before committing to supporting it. Especially as their variants don't align with our asides 1:1, so we'd need to think about how to handle their Important/Warning/Caution types. It looks like https://github.com/hyoban/remark-github-alerts might work though? Could be added as a remark plugin in the Astro config to add this functionality for users who need it. |
Beta Was this translation helpful? Give feedback.
-
Starlight supports different syntax for the same feature: :::note
Highlights information that users should take into account, even when skimming.
::: |
Beta Was this translation helpful? Give feedback.
-
Closing since as @delucis called out there is a preference to wait for the Github API to remain stable before supporting |
Beta Was this translation helpful? Give feedback.
-
What version of
starlight
are you using?0.22.4
What is your idea?
As described In Github's Docs for markdown alerts (which are written in blockquote syntax) are rendered in a specific way which makes a clear callout to the reader.
Like so:
Tip
Helpful advice for doing things better or more easily.
It would be great if Starlight supported matching this functionality in it's rendered output. It isn't required, but it would be a plus if there was an option (or a default) to have this actually rendered as a Starlight Aside
Why is this feature necessary?
Markdown written on Github often contains these alerts now that they are supported, and currently in Starlight this is rendered as a blockquote which can easily have the information be lost (or at the very least, not follow it's original intention of being a callout to a reader).
Do you have examples of this feature in other projects?
Note
Useful information that users should know, even when skimming content.
Participation
Beta Was this translation helpful? Give feedback.
All reactions