MyST-Parser
MyST-Parser copied to clipboard
Amonitions `class` option value: space- or comma-separated list?
Describe the gap in the current documentation
The “Admonition types” section reads:
These admonitions take no argument, but may be specified with options:
class: A space-separated list of CSS classes to add to the admonition.
but, in the syntax just below, the value of this class option is a comma-separated list:
:::{tip}
:class: myclass1,myclass2
:name: a-tip-reference
Let's give readers a helpful hint!
:::
[Reference to my tip](#a-tip-reference)
Describe the solution you'd like
Make the wording and the syntax consistent.
Yep just double checked and it should be space separated: https://docutils.sourceforge.io/docs/ref/rst/directives.html#class-1