How to use roles and directives

[westurner]

Is your feature request related to a problem? Please describe.

There doesn't seem to be an example of how to use roles and directives in the docs?

A link to the documentation page where you see an issue.

• Does this need to be on its own page?

Describe the solution you'd like

• [ ] Show examples of how to use roles and directives (with arguments)

See also: "Steps for custom role in Jupyter Book?" https://github.com/executablebooks/meta/discussions/101

[chrisjsewell]

The main initial discussion of MySt Markdown is here: https://myst-nb.readthedocs.io/en/latest/use/myst.html#writing-myst-markdown, which provides a link to the "full" syntax guide: https://myst-parser.readthedocs.io/en/latest/using/syntax.html

But yes if you think it would be helpful to copy a few examples from their, into the MyST-NB section, sounds good. Do you want to make a PR?

There is also syntax examples in: https://myst-nb.readthedocs.io/en/latest/examples/basic.html#syntax