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

Enhancement to support Github style callouts #65

Open
raven42 opened this issue Dec 13, 2023 · 0 comments
Open

Enhancement to support Github style callouts #65

raven42 opened this issue Dec 13, 2023 · 0 comments

Comments

@raven42
Copy link

raven42 commented Dec 13, 2023

Would it be possible to add support for github style callouts in markdown and have them render as sphinx admonitions?

Currently if I have a markdown document defined like this:

# Some Section

Some paragraph

> :warning: Some warning message

On github markdown, it renders like this with the 'warning' icon:

Some Section

Some paragraph

⚠️ Some warning message

However when using the m2r2 to convert the markdown, it treats this as a parameter listing like this:

Some section
============

Some paragraph

..

   :warning: Some warning message

Which in the sphinx compiled html output, it renders like this:
image

Ideally it would be nice if this could support github style callouts like this and render it as a sphinx warning/note/etc directive instead like this:

Some section
============

Some paragraph

.. warning::

   Some warning message

image

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

No branches or pull requests

1 participant