(md/plugins)=

Plugin extensions

The following plugins are embedded within the core package (enabled when using the "default" preset configuration):

Other plugins are then available via the markdown_it.extensions package:

  • footnote is based on the pandoc definition:

    Normal footnote:

Here is a footnote reference,[^1] and another.[^longnote]

[^1]: Here is the footnote.

[^longnote]: Here's one with multiple blocks.

    Subsequent paragraphs are indented to show that they
belong to the previous footnote.

  • front-matter parses initial metadata, stored between opening/closing dashes:

    ---
valid-front-matter: true
---

  • containers is a plugin for creating block-level custom containers:

    ::::: name
:::: name
*markdown*
::::
:::::

  • deflist syntax is based on pandoc definition lists.

    Term 1

: Definition 1 long form

  second paragraph

Term 2 with *inline markup*
  ~ Definition 2a compact style
  ~ Definition 2b

  • texmath parses TeX math equations set inside opening and closing delimiters:

    $\alpha = \frac{1}{2}$

  • dollarmath is an improved version of texmath, for $/$$ enclosed math only. It is more performant, handles \ escaping properly and allows for more configuration.

  • amsmath also parses TeX math equations, but without the surrounding delimiters and only for top-level amsmath environments:

    \begin{gather*}
a_1=b_1+c_1\\
a_2=b_2+c_2-d_2+e_2
\end{gather*}

  • myst_blocks and myst_role plugins are utilised by the MyST renderer

There are also many other plugins which could easily be ported (and hopefully will be):