Project: remarkjs/remark-math

Package: remark-math@5.1.1

  1. Dependents: 0
  2. remark plugin to parse and stringify math
  1. remark 218
  2. unified 184
  3. markdown 162
  4. plugin 143
  5. mdast 91
  6. remark-plugin 84
  7. math 6
  8. latex 6
  9. tex 5
  10. katex 4


Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to support math ($C_L$).


What is this?

This package is a unified (remark) plugin to add support for math. You can use this to add support for parsing and serializing this syntax extension.

unified is a project that transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. micromark is the markdown parser we use. This is a remark plugin that adds support for the math syntax and AST to remark.

When should I use this?

This project is useful when you want to support math in markdown. Extending markdown with a syntax extension makes the markdown less portable. LaTeX equations are also quite hard. But this mechanism works well when you want authors, that have some LaTeX experience, to be able to embed rich diagrams of math in scientific text.


This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install remark-math

In Deno with esm.sh:

import remarkMath from 'https://esm.sh/remark-math@5'

In browsers with esm.sh:

<script type="module">
  import remarkMath from 'https://esm.sh/remark-math@5?bundle'


Say we have the following file example.md:

Lift($L$) can be determined by Lift Coefficient ($C_L$) like the following

L = \frac{1}{2} \rho v^2 S C_L

And our module example.js looks as follows:

import {read} from 'to-vfile'
import {unified} from 'unified'
import remarkParse from 'remark-parse'
import remarkMath from 'remark-math'
import remarkRehype from 'remark-rehype'
import rehypeKatex from 'rehype-katex'
import rehypeStringify from 'rehype-stringify'

const file = await unified()
  .process(await read('example.md'))


Now running node example.js yields:

<p>Lift(<span class="math math-inline"><span class="katex"></span></span>) can be determined by Lift Coefficient (<span class="math math-inline"><span class="katex"></span></span>) like the following equation.</p>
<div class="math math-display"><span class="katex-display"></span></div>


This package exports no identifiers. The default export is remarkMath.

unified().use(remarkMath[, options])

Plugin to support math.


Configuration (optional).


Whether to support math (text) with a single dollar (boolean, default: true). Single dollars work in Pandoc and many other places, but often interfere with “normal” dollars in text.

If you turn this off, you can still use two or more dollars for text math.


This plugin applies a micromark extensions to parse the syntax. The syntax basically follows how code works in markdown, except that dollars ($) are used instead of backticks (`) and that 2 or more dollars instead of 3 or more backticks is enough for blocks.

See its readme for parse details:

👉 Note: $math$ works similar to `code`. That means escapes don’t work inside math but you can use more dollars around the math instead: $$\raisebox{0.25em}{$\frac a b$}$$

👉 Note: Like code, the difference between “inline” and “block”, is in the line endings:




This plugin integrates with remark-rehype. When mdast (markdown AST) is turned into hast (the HTML AST) the math nodes are turned into <span class=math-inline> and <div class=math-block> elements.

Syntax tree

This plugin applies one mdast utility to build and serialize the AST. See its readme for the node types supported in the tree:


This package is fully typed with TypeScript. It exports an extra Options type which models the interface of the accepted options.

If you’re working with the syntax tree, make sure to import this plugin somewhere in your types, as that registers the new node types in the tree.

/** @typedef {import('remark-math')} */

import {visit} from 'unist-util-visit'

/** @type {import('unified').Plugin<[], import('mdast').Root>} */
export default function myRemarkPlugin() => {
  return (tree) => {
    visit(tree, (node) => {
      // `node` can now be one of the nodes for math.


Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

This plugin works with unified version 6+ and remark version 14+. The previous major (version 4) worked with remark 13.


Use of remark-math itself does not open you up to cross-site scripting (XSS) attacks. Always be wary of user input and use rehype-sanitize.


See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.


MIT © Junyoung Choi