Skip to main content

@mdit/plugin-mathjax

Plugins to render math expressions with Mathjax, you should install mathjax-full as peer dependency.

Note

This plugin is based on @mdit/plugin-tex.

Usage Node.js runtime only

TS
import MarkdownIt from "markdown-it";
import { createMathjaxInstance, mathjax } from "@mdit/plugin-mathjax";

const mathjaxInstance = createMathjaxInstance(options);
const mdIt = MarkdownIt().use(mathjax, mathjaxInstance);

const html = mdIt.render("$E=mc^2$");
const style = mathjaxInstance.outputStyle();

This plugin is a bit different from other plugins. It requires you to create a Mathjax instance with options first, and then pass it to the plugin.

You can set the following options:

interface MarkdownItMathjaxOptions {
  /**
   * Output syntax
   *
   * @default 'svg'
   */

  output?: "chtml" | "svg";

  /**
   * Whether to allow inline math with spaces on ends
   *
   * @description NOT recommended to set this to true, because it will likely break the default usage of $
   *
   * @default false
   */
  allowInlineWithSpace?: boolean;

  /**
   * Whether parsed fence block with math language to display mode math
   *
   * @default false
   */
  mathFence?: boolean;

  /**
   * Enable A11y
   *
   * @default true
   */
  a11y?: boolean;

  /**
   * TeX input options
   */
  tex?: MathJaxTexInputOptions;

  /**
   * Common HTML output options
   */
  chtml?: MathjaxCommonHTMLOutputOptions;

  /**
   * SVG output options
   */
  svg?: MathjaxSVGOutputOptions;
}

The instance holds render content of each calls, so you should:

  • Call mathjaxInstance.reset() before each render in different pages, this ensure things like label are reset.
  • Call mathjaxInstance.outputStyle() after all rendering is done, to get final CSS content.
  • Call mathjaxInstance.clearStyle() to clear existing style cache if necessary.

We also have a package called @mdit/plugin-mathjax-slim which mathjax-full is an optional dep.

Syntax

You should use $tex expression$ inline, and use $$tex expression$$ for block.

Escaping

  • You can use \ to escape $:

    Euler’s identity \$e^{i\pi}+1=0$

    will be

    Euler’s identity $e^{i\pi}+1=0$

Demo

Demo

Euler’s identity eiπ+1=0 is a beautiful formula in R2.

∂r∂ωr(yωω)=(yωω){(log⁡y)r+∑i=1r(−1)Ir⋯(r−i+1)(log⁡y)riωi}
Euler’s identity $e^{i\pi}+1=0$ is a beautiful formula in $\mathbb{R}^2$.

$$
\frac {\partial^r} {\partial \omega^r} \left(\frac {y^{\omega}} {\omega}\right)
= \left(\frac {y^{\omega}} {\omega}\right) \left\{(\log y)^r + \sum_{i=1}^r \frac {(-1)^ Ir \cdots (r-i+1) (\log y)^{ri}} {\omega^i} \right\}
$$

Support List

Cookbook