Skip to main content

Module admonitions

Module admonitions 

Source
Expand description

Admonition opener detection.

Recognizes python-markdown admonitions (!!! type "title") and the pymdownx.details collapsible variants (??? / ???+). Both open a container whose 4-space-indented body is parsed recursively (see the Admonition container, which closes on dedent like a footnote definition). Only the opener line is parsed here; the body is handled by the container machinery.

Syntax (mirrors python-markdown / pymdownx):

!!! type "Optional title"
??? type "Optional title"     (collapsed)
???+ type "Optional title"    (expanded)

type is one or more space-separated class words ([\w\-]+); the first is the admonition type, the rest extra classes. The quoted title is optional. For !!! the type is required; for ???/???+ it is optional. Anything other than class words plus an optional trailing quoted title disqualifies the line (so ordinary paragraphs starting with !!! are left alone).