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

feat: support GFM-style alerts in Markdown #954

Open
mcdurdin opened this issue Jan 25, 2024 · 5 comments
Open

feat: support GFM-style alerts in Markdown #954

mcdurdin opened this issue Jan 25, 2024 · 5 comments
Assignees
Labels
Milestone

Comments

@mcdurdin
Copy link
Member

mcdurdin commented Jan 25, 2024

From #952.

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

@mcdurdin mcdurdin added this to the 18.0 milestone Jan 25, 2024
@mcdurdin mcdurdin added the feat label Jan 25, 2024
@mcdurdin mcdurdin transferred this issue from keymanapp/keyman Jan 25, 2024
@mcdurdin mcdurdin modified the milestones: 18.0, A18S2 Apr 29, 2024
@mcdurdin
Copy link
Member Author

mcdurdin commented May 3, 2024

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
Copy link
Member Author

mcdurdin commented May 3, 2024

For reference, this is what we are looking for!

image

@mcdurdin mcdurdin modified the milestones: A18S2, A18S3 May 24, 2024
@Meng-Heng
Copy link
Collaborator

@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:
    image

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

@mcdurdin
Copy link
Member Author

mcdurdin commented Jun 7, 2024

@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 erusev/parsedown#860 as well.

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

@Meng-Heng
Copy link
Collaborator

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.

@mcdurdin mcdurdin modified the milestones: A18S3, A18S4 Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

2 participants