jupyter-book / myst-enhancement-proposals

MyST Enhancement Proposals (MEPs)
https://mep.mystmd.org
MIT License
8 stars 3 forks source link

Colon Directives / Divs #13

Open rowanc1 opened 1 year ago

rowanc1 commented 1 year ago

Colon fences are in use in all of the implementations of MyST, however, are not yet defined in the myst-spec. We should add these and document the current behaviour that we can then improve upon in the future.

The colon_fence extension [..] works exactly the same as normal ``` code fences, but using ::: delimiters.

:::{admonition} The title
:class: note

This note contains *Markdown*
:::

E.g. documented in JupyterBook here:

I think that this needs to come in before #12, as that may require colon fences.

Some text that I have used on when to use each syntax:

Pointers to other projects:

chrisjsewell commented 1 year ago

As mentioned in #12, I would suggest that perhaps these should no longer be called "colon fences", but instead div (or whatever), and have a somewhat different semantic to fences (i.e. ``` enclosed blocks)