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 GFM admonitions #114

Open
henryiii opened this issue Aug 14, 2024 · 3 comments
Open

Support GFM admonitions #114

henryiii opened this issue Aug 14, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@henryiii
Copy link

Context

See executablebooks/MyST-Parser#845. Basically this:

> [!NOTE]
> This is a note

Looks like this on GitHub:

Note

This is a note

It was suggested in that issue that the implementation should start here.

Proposal

This is a feature of GFM, so it should be supported.

Tasks and updates

No response

@henryiii henryiii added the enhancement New feature or request label Aug 14, 2024
@KyleKing
Copy link
Contributor

Hi @henryiii, you can format Github Admonitions today with mdformat-gfm-alerts (https://github.com/KyleKing/mdformat-gfm-alerts?tab=readme-ov-file#mdformat-gfm-alerts)!

Let me know if you run into any issues

@henryiii
Copy link
Author

This is only for formatting? Is there also a way to use it in myst/markdown-it-py/jupyter-book?

@KyleKing
Copy link
Contributor

If you install the package in the environment, the Renderer should be auto-discovered. There is just one issue with removing the outer block quote that I'll solve eventually and I'm open to PRs: https://github.com/KyleKing/mdformat-gfm-alerts?tab=readme-ov-file#html-rendering

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants