remark-math
Advanced tools
The remark-math package is a plugin for the remark markdown processor that allows you to parse and render mathematical expressions written in LaTeX. It supports both inline and block math expressions, making it useful for documents that require mathematical notation.
Inline Math
This feature allows you to include inline mathematical expressions within your markdown text. The example demonstrates how to use the remark-math plugin to parse and render an inline math expression.
const remark = require('remark');
const remarkMath = require('remark-math');
const html = require('remark-html');
remark()
.use(remarkMath)
.use(html)
.process('Here is some inline math: $E=mc^2$', function (err, file) {
if (err) throw err;
console.log(String(file));
});Block Math
This feature allows you to include block mathematical expressions in your markdown text. The example demonstrates how to use the remark-math plugin to parse and render a block math expression.
const remark = require('remark');
const remarkMath = require('remark-math');
const html = require('remark-html');
remark()
.use(remarkMath)
.use(html)
.process('$$\int_0^\infty e^{-x} \, dx = 1$$', function (err, file) {
if (err) throw err;
console.log(String(file));
});markdown-it-math is a plugin for the markdown-it parser that allows you to include LaTeX math expressions in your markdown documents. It supports both inline and block math, similar to remark-math, but is designed to work with the markdown-it ecosystem.
KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web. While it is not a markdown plugin itself, it can be used in conjunction with markdown parsers to render math expressions. It is known for its speed and reliability.
MathJax is a JavaScript display engine for mathematics that works in all browsers. It supports a wide range of LaTeX and MathML expressions. Like KaTeX, it is not a markdown plugin but can be integrated with markdown parsers to render math expressions.
remark plugin to support math ($C_L$).
This package is a unified (remark) plugin to add support for math syntax. You can use this to add support for parsing and serializing this syntax extension.
As there is no spec for math in markdown, this extension follows how code
(fenced and text) works in Commonmark, but uses dollars ($).
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.
If you just want to turn markdown into HTML (with maybe a few extensions such
as math), we recommend micromark with
micromark-extension-math instead.
If you don’t use plugins and want to access the syntax tree, you can use
mdast-util-from-markdown with
mdast-util-math.
This plugins adds fields on nodes so that the
plugin responsible for turning markdown (mdast) into HTML (hast),
remark-rehype, will turn text math (inline) into
<code class="language-math math-inline">…</code> and flow math (block)
into <pre><code class="language-math math-display">…</code></pre>.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-math
In Deno with esm.sh:
import remarkMath from 'https://esm.sh/remark-math@6'
In browsers with esm.sh:
<script type="module">
import remarkMath from 'https://esm.sh/remark-math@6?bundle'
</script>
Say our document example.md contains:
Lift($$L$$) can be determined by Lift Coefficient ($$C_L$$) like the following
equation.
$$
L = \frac{1}{2} \rho v^2 S C_L
$$
…and our module example.js contains:
import rehypeKatex from 'rehype-katex'
import rehypeStringify from 'rehype-stringify'
import remarkMath from 'remark-math'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import {read} from 'to-vfile'
import {unified} from 'unified'
const file = await unified()
.use(remarkParse)
.use(remarkMath)
.use(remarkRehype)
.use(rehypeKatex)
.use(rehypeStringify)
.process(await read('example.md'))
console.log(String(file))
…then running node example.js yields:
<p>Lift(<code class="language-math math-inline"><span class="katex">…</span></code>) like the following
equation.</p>
<pre><code class="language-math math-display"><span class="katex-display"><span class="katex">…</span></span></code></pre>
This package exports no identifiers.
The default export is remarkMath.
unified().use(remarkMath[, options])Add support for math.
options (Options, optional)
— configurationNothing (undefined).
OptionsConfiguration (TypeScript type).
singleDollarTextMath (boolean, default: true)
— whether to support text math (inline) with a single dollar.
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.When authoring markdown with math, keep in mind that math doesn’t work in most places. Notably, GitHub currently has a really weird crappy client-side regex-based thing. But on your own (math-heavy?) site it can be great!
Instead of a syntax extension to markdown, you can also use fenced code with an
info string of math:
```math
L = \frac{1}{2} \rho v^2 S C_L
```
This plugin integrates with remark-rehype.
When markdown (mdast) is turned into HTML (hast) the math nodes are turned
into <code class="language-math math-inline">…</code> and
<pre><code class="language-math math-display">…</code></pre> elements.
This package does not relate to CSS. You can choose to render the math with KaTeX, MathJax, or something else, which might need CSS.
See Syntax in
micromark-extension-math.
See Syntax tree in
mdast-util-math.
This package is fully typed with TypeScript.
It exports the additional type Options.
If you’re working with the syntax tree, you can register the new node types
with @types/mdast by adding a reference:
// Register math nodes in mdast:
/// <reference types="mdast-util-math" />
import {visit} from 'unist-util-visit'
function myRemarkPlugin() {
/**
* @param {import('mdast').Root} tree
* Tree.
* @returns {undefined}
* Nothing.
*/
return function (tree) {
visit(tree, function (node) {
console.log(node) // `node` can now be one of the math nodes.
})
}
}
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, remark-math@^6,
compatible with Node.js 16.
This plugin works with unified version 6+ and remark version 14+. The previous major (version 4) worked with remark 13.
Use of remark-math does not involve rehype (hast) or user
content so there are no openings for cross-site scripting (XSS)
attacks.
remark-gfm
— support GFM (autolink literals, footnotes, strikethrough, tables,
tasklists)remark-frontmatter
— support frontmatter (YAML, TOML, and more)remark-directive
— support directivesremark-mdx
— support MDX (ESM, JSX, expressions)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.
FAQs
remark plugin to parse and stringify math
We found that remark-math demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.