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

Support rendering markdown "alerts" syntax #132

Closed
magurotuna opened this issue Mar 2, 2024 · 1 comment
Closed

Support rendering markdown "alerts" syntax #132

magurotuna opened this issue Mar 2, 2024 · 1 comment
Labels
bug Something isn't working docs gen Related to the documentation generation

Comments

@magurotuna
Copy link
Contributor

It would be great if we could add support for rendering "alerts" syntax that's available recently in GitHub: https://github.com/orgs/community/discussions/16925

An example that uses this syntax is @badrap/valita. As shown in the screenshot below, this syntax is rendered with no decoration, which is okay but not ideal.

Pasted_Image_2024_03_03_0_01

To support this syntax, we need to fix markdown parsing logic performed in the backend API server, which intenally calls deno_doc::html::jsdoc::markdown_to_html, and finally ending up with comrak crate as a markdown parser library. The problem is that this crate doesn't plan to support "alerts" syntax at least for the time being (see kivikakk/comrak#352). We need to come up with another solution here.

@lucacasonato lucacasonato added the bug Something isn't working label Mar 2, 2024
@crowlKats crowlKats added the docs gen Related to the documentation generation label Mar 2, 2024
@lucacasonato lucacasonato added this to JSR Mar 4, 2024
@github-project-automation github-project-automation bot moved this to Needs Plan in JSR Mar 4, 2024
@lucacasonato lucacasonato moved this from Needs Plan to Ready in JSR Mar 4, 2024
@crowlKats
Copy link
Collaborator

Closing as this was implemented

@github-project-automation github-project-automation bot moved this from Ready to Done in JSR Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs gen Related to the documentation generation
Projects
Status: Done
Development

No branches or pull requests

3 participants