Skip to content

tani/markdown-it-mathjax3

Repository files navigation

markdown-it-mathjax3

Note

markdown-it-mathjax3 now supports XyJaX-v3! You can draw commutative diagrams using xypic.

Add Math to your Markdown

This is a fork of markdown-it-katex to support MathJax v3 and SVG rendering.

Quick Start

  1. Install markdown-it and this plugin

    npm install markdown-it markdown-it-mathjax3
    
  2. Use it in your code

    var md = require('markdown-it')(),
        mathjax3 = require('markdown-it-mathjax3');
    
    md.use(mathjax3);
    
    // double backslash is required for javascript strings, but not html input
    var result = md.render('# Math Rulez! \n  $\\sqrt{3x-1}+(1+x)^2$');

Usage with TypeScript

import MarkdownIt from 'markdown-it';
import mathjax3 from 'markdown-it-mathjax3';

const md = new MarkdownIt();
md.use(mathjax3);

const result = md.render('$\\sqrt{3x-1}+(1+x)^2$');

Features

  • Fast rendering: Uses optimized SVG output for quick math rendering
  • Full LaTeX support: Supports all standard LaTeX math commands through MathJax
  • Inline and block math: Use single $ for inline math and double $$ for display math
  • Lightweight: Minimal dependencies with optimized bundle size
  • TypeScript support: Includes TypeScript definitions

Examples

Inline

Surround your LaTeX with a single $ on each side for inline rendering.

$\sqrt{3x-1}+(1+x)^2$

Block

Use two ($$) for block rendering. This mode uses bigger symbols and centers the result.

$$\begin{array}{c}

\nabla \times \vec{\mathbf{B}} -\, \frac1c\, \frac{\partial\vec{\mathbf{E}}}{\partial t} &
= \frac{4\pi}{c}\vec{\mathbf{j}}    \nabla \cdot \vec{\mathbf{E}} & = 4 \pi \rho \\

\nabla \times \vec{\mathbf{E}}\, +\, \frac1c\, \frac{\partial\vec{\mathbf{B}}}{\partial t} & = \vec{\mathbf{0}} \\

\nabla \cdot \vec{\mathbf{B}} & = 0

\end{array}$$

Syntax

Math parsing in markdown is designed to agree with the conventions set by pandoc:

Anything between two $ characters will be treated as TeX math. The opening $ must
have a non-space character immediately to its right, while the closing $ must
have a non-space character immediately to its left, and must not be followed
immediately by a digit. Thus, $20,000 and $30,000 won’t parse as math. If for some
reason you need to enclose text in literal $ characters, backslash-escape them and
they won’t be treated as math delimiters.

About

Add Math to your Markdown with a MathJax plugin for Markdown-it

Resources

License

Stars

Watchers

Forks

Packages

No packages published