feat: support GFM-style alerts in Markdown

keymanapp / help.keyman.com

https://help.keyman.com/ source

7 stars 29 forks source link

feat: support GFM-style alerts in Markdown #954

Open mcdurdin opened 7 months ago

mcdurdin commented 7 months ago

From #952.

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

mcdurdin commented 4 months ago

This has to be added as a extension to Parsedown, which is the Markdown renderer that we use.

https://github.com/orgs/community/discussions/16925 shows the styles we are aiming for, let's stick with those.

There may be a feature in Parsedown that does this for us, I haven't looked.

mcdurdin commented 4 months ago

For reference, this is what we are looking for!

Meng-Heng commented 3 months ago

@mcdurdin, I don't think Parsedown has this feature yet.

A request for Alerts support: https://github.com/erusev/parsedown/issues/860
Latest Parsedown releases do not mention the Alerts feature: https://github.com/erusev/parsedown/releases
Other markdown renderers start supporting Alerts upon the User's request: https://github.com/jgm/commonmark-hs/issues/132
Parsedown's demo page:

I also don't see this feature being added to their v2.0.0 roadmap.

mcdurdin commented 3 months ago

@Meng-Heng, we'd need to write this as an extension. Parsedown has a tutorial on writing extensions: https://github.com/erusev/parsedown/wiki/Tutorial:-Create-Extensions

It might be worth reading links https://github.com/erusev/parsedown/issues/860 as well.

If this seems a bit too deep, no worries, we can postpone this and come back to it later

Meng-Heng commented 3 months ago

Thank you @mcdurdin, I have started a composer project on Wednesday so I would like to take a look through the links you sent and see how much I can go from there.