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

Colon Directives / Divs #13

Open
rowanc1 opened this issue Feb 24, 2023 · 1 comment
Open

Colon Directives / Divs #13

rowanc1 opened this issue Feb 24, 2023 · 1 comment

Comments

@rowanc1
Copy link
Member

rowanc1 commented Feb 24, 2023

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
Copy link
Contributor

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)

@rowanc1 rowanc1 changed the title Colon Fences Colon Directives / Divs Feb 24, 2023
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

2 participants