-
Notifications
You must be signed in to change notification settings - Fork 251
Add syntax for admonition blocks. #189
Comments
It would be great if recommonmark supported this. |
AutoStructify recommends this syntax, but it doesn't seem to work if you want an admonition with multiple lines or extra markdown formatting:
|
Dug into this a little bit today, just to give some extra information that I think is relevant: The bits that over-load code cell syntax and convert them to directive syntax is in the Specifically, the The other issue with that is that it's using an instance of the docutils Parser to parse the contents of the directive block, and that parser will assume that the contents are in reStructuredText rather than markdown, so you can't do things like: ```note:: this [is a link](mylink.com) It also feels relevant that the state machine used in the transform for |
I support the syntax first proposed by noahtren:
This seems to be the default in the markdown in this space:
Could we plug in or use the python-mardown extension with recommonmark? |
Note that nested parsing of Markdown is supported in https://myst-parser.readthedocs.io/en/latest/using/syntax.html#directives-a-block-level-extension-point (as used by jupyterbook), for admonitions and any other directive, currently as: ```{note}
This note is written in [markdown](https://example.com)
``` with potentially more markdown friendly syntax specific for admonitions to come: executablebooks/MyST-Parser#154 |
At the moment, embedding reST using
eva_rst
is the only way to render admonition blocks. It would be great to have a better syntax for admonition blocks that allows the content of admonitions to be written in Markdown and fall back reasonably on GitHub.The text was updated successfully, but these errors were encountered: