Mathematics

On this page

DocSprout bundles the MIT-licensed KaTeX runtime, stylesheet and fonts with every generated site. Math works offline, in GitHub Pages, and in downloaded documentation archives—no CDN is used.

Inline math

Use a single dollar delimiter:

Euler's identity is $e^{i\pi} + 1 = 0$.

Inline math is TeX, not Markdown prose: emphasis, link/image syntax, typography conversion, and code transformation do not apply inside $...$ . Link/image syntax inside inline math is neither resolved nor audited.

Display math

Use a fenced math block for the clearest source:

\left(\sum_{k=1}^{n} a_k b_k\right)^2 \leq \left(\sum_{k=1}^{n} a_k^2\right) \left(\sum_{k=1}^{n} b_k^2\right)

$$ delimiters are also supported:

\int_0^1 x^2\,dx = \frac{1}{3}

The same common LaTeX syntax renders on GitHub, which uses MathJax. KaTeX and MathJax do not have identical macro coverage; keep project notation within the well-supported KaTeX subset for consistent repository and site rendering.

KaTeX source and licence are included at src/docsprout/vendor/katex/.