Support GitHub's note/warning/information alerts?

Question

Support GitHub's note/warning/information alerts?

Elchi3 opened this issue a year ago · 12 comments

Elchi3 commented a year ago

Initial checklist

I read the support docs
I read the contributing guide
I agree to follow the code of conduct
I searched issues and couldn’t find anything (or linked relevant results below)

Problem

Currently, there are many different ways to express note/warning/information alert boxes.

For example, from your own docs, this could be transformed into a GitHub note box:

👉 Note: before participating in our community, please read our
[code of conduct][coc].

MDN searches for the following syntax to render an alert box:

Warning: If you just see "1 3" instead of a fraction, then your browser may not support MathML.

Solution

GitHub seems to have added a syntax for note/warning/info alert boxes to GFM. They render like this:

Note

Highlights information that users should take into account, even when skimming.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

See https://github.com/orgs/community/discussions/16925

Will this be supported in remark-gfm?

Alternatives

.

Answer 1 · 2023-08-01T12:24:13.000Z

remark-gfm is about adding GFM syntax. What you’re proposing, is to alter HTML output. This is out of scope for this project. It would be nice to have in https://github.com/rehypejs/rehype-github though.

Answer 2 · 2023-08-01T12:24:25.000Z

Hi! This was closed. Team: If this was fixed, please add phase/solved. Otherwise, please add one of the no/* labels.

Answer 3 · 2023-08-01T12:25:20.000Z

Hi team! Could you describe why this has been marked as external?

Thanks,
— bb

Answer 4 · 2023-08-01T12:25:39.000Z

Hi team! I don’t know what’s up as there’s no phase label. Please add one so I know where it’s at.

Thanks,
— bb

Answer 5 · 2023-08-01T12:25:39.000Z

Hi team! I don’t know what’s up as there’s no phase label. Please add one so I know where it’s at.

Thanks,
— bb

Answer 6 · 2023-08-01T12:27:02.000Z

Hi team! Could you describe why this has been marked as external?

Thanks,
— bb

Answer 7 · 2023-08-01T12:31:39.000Z

remark-gfm is about adding GFM syntax.

Thanks, my understanding was that > [!NOTE] , > [!IMPORTANT] and > [!WARNING] is new GFM syntax.

What you’re proposing, is to alter HTML output. This is out of scope for this project. It would be nice to have in https://github.com/rehypejs/rehype-github though.

Okay, I'm happy to file an issue there.

Answer 8 · 2023-08-01T12:38:20.000Z

Oh, I see they recently added a new syntax. Now I’m not entirely sure anymore.

Answer 9 · 2023-08-01T12:38:34.000Z

Hi team! I don’t know what’s up as there’s no phase label. Please add one so I know where it’s at.

Thanks,
— bb

Answer 10 · 2023-08-01T13:36:55.000Z

Hi!

is new GFM syntax.

There are tons of features GH does on its platform to markup.
There are very few features part of GFM. Here is their GFM parser: https://github.com/github/cmark-gfm. It does not include this.
So remco is correct, this does not go here!

Answer 11 · 2023-08-01T13:37:10.000Z

Hi! This was closed. Team: If this was fixed, please add phase/solved. Otherwise, please add one of the no/* labels.

Answer 12 · 2024-03-03T23:30:41.000Z

For anyone interested; I created a Remark plugin to transform GitHub's syntax to the directives syntax used by admonitions: remark-github-admonitions-to-directives