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 GitHub-style blockquote admonitions #1009

Open
wlach opened this issue Jan 7, 2025 · 0 comments
Open

Support GitHub-style blockquote admonitions #1009

wlach opened this issue Jan 7, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@wlach
Copy link

wlach commented Jan 7, 2025

Describe the feature you'd like to request

GitHub supports admonitions via a slightly different syntax than MyST:

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

e.g.

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

It would be great if you could write admonitions in either style and have them render, as sometimes documentation is read on both GitHub and as part of a Sphinx docset.

Describe the solution you'd like

Support this feature (probably via an opt-in syntax extension).

@wlach wlach added the enhancement New feature or request label Jan 7, 2025
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

1 participant