Follow us on TwitterFork us on GitHub
MyST

Admonitions

Admonitions highlight a particular block of text that exists slightly apart from the narrative of your page, like so:

#Specification

Admonition node for drawing attention to text, separate from the neighboring content

type: string, ("admonition")
See also
kind: string, optional, ("attention" | "caution" | "danger" | "error" | "hint" | "important" | "note" | "seealso" | "tip" | "warning")
kind of admonition, to determine styling
class: string, optional
admonition class info to override kind
children: array, ( | )
An optional admonitionTitle followed by the admonitions content.
See also
position: object, optional, ()
See also
data: object, optional
See also

#Example

Markup
AST
Render