Module

plugins.math

Math plugin for Patitas.

Adds support for LaTeX-style math expressions.

Usage:

>>> md = create_markdown(plugins=["math"])
>>> md("Inline: $E = mc^2$")
'<p>Inline: <span class="math">E = mc^2</span></p>'
>>> md("$$

E = mc^2 $$") '

E = mc^2
'

Syntax:

Inline math: $expression$ Block math: $$expression$$ (on separate lines)

Escaping:

  • \$for literal dollar sign
  • Inside code spans, $ is literal

Notes:

  • This plugin outputs semantic HTML classes
  • Actual math rendering (MathJax, KaTeX) is done client-side
  • Block math with display mode is on separate lines

Thread Safety:

This plugin is stateless and thread-safe.

1Class

Classes

MathPlugin 4 ▼
Plugin adding $math$ and $$math$$ support. Inline math uses $...$ syntax. Block math uses $$...$$ …

Plugin adding $math$ and $$math$$ support.

Inline math uses $...$ syntax. Block math uses $$...$$ on separate lines.

Methods

name 0 str ▼
property
def name(self) -> str
Returns
str
extend_lexer 1 ▼
Enable math detection in lexer.
def extend_lexer(self, lexer_class: type[Lexer]) -> None
Parameters
Name Type Description
lexer_class —
extend_parser 1 ▼
Enable math parsing.
def extend_parser(self, parser_class: type[Parser]) -> None
Parameters
Name Type Description
parser_class —
extend_renderer 1 ▼
Math rendering is handled in base renderer.
def extend_renderer(self, renderer_class: type[HtmlRenderer]) -> None
Parameters
Name Type Description
renderer_class —