mdit_py_plugins.amsmath Namespace Reference

Functions
None	amsmath_plugin (MarkdownIt md, *Callable[[str], str]|None renderer=None)
bool	amsmath_block (StateBlock state, int startLine, int endLine, bool silent)

Variables
list	ENVIRONMENTS
str	RE_OPEN = r"\\begin\{(" + "|".join(ENVIRONMENTS) + r")([\*]?)\}"

Detailed Description

An extension to capture amsmath latex environments.

Function Documentation

amsmath_plugin()

None mdit_py_plugins.amsmath.amsmath_plugin	(	MarkdownIt	md,
		*Callable[[str], str] | None	renderer = None
	)

Parses TeX math equations, without any surrounding delimiters,
only for top-level `amsmath <https://ctan.org/pkg/amsmath>`__ environments:

.. code-block:: latex

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

:param renderer: Function to render content, by default escapes HTML

Variable Documentation

ENVIRONMENTS

list mdit_py_plugins.amsmath.ENVIRONMENTS

Initial value:

=  [
    # 3.2 single equation with an automatically gen-erated number
    "equation",
    # 3.3 variation equation, used for equations that dont fit on a single line
    "multline",
    # 3.5 a group of consecutive equations when there is no alignment desired among them
    "gather",
    # 3.6 Used for two or more equations when vertical alignment is desired
    "align",
    # allows the horizontal space between equationsto be explicitly specified.
    "alignat",
    # stretches the space betweenthe equation columns to the maximum possible width
    "flalign",
    # 4.1 The pmatrix, bmatrix, Bmatrix, vmatrix and Vmatrix have (respectively)
    # (),[],{},||,and ‖‖ delimiters built in.
    "matrix",
    "pmatrix",
    "bmatrix",
    "Bmatrix",
    "vmatrix",
    "Vmatrix",
    # eqnarray is another math environment, it is not part of amsmath,
    # and note that it is better to use align or equation+split instead
    "eqnarray",
]