TypeScript icon, indicating that this package has built-in type declarations

7.0.0 • Public • Published


Build Coverage Downloads Size Sponsors Backers Chat

rehype plugin to render elements with a language-math class with KaTeX.


What is this?

This package is a unified (rehype) plugin to render math. You can add classes to HTML elements, use fenced code in markdown, or combine with remark-math for a $C$ syntax extension.

When should I use this?

This project is useful as it renders math with KaTeX at compile time, which means that there is no client side JavaScript needed.

A different plugin, rehype-mathjax, does the same but with MathJax.


This package is ESM only. In Node.js (version 16+), install with npm:

npm install rehype-katex

In Deno with

import rehypeKatex from ''

In browsers with

<script type="module">
  import rehypeKatex from ''


Say our document input.html contains:

  Lift(<code class="language-math">L</code>) can be determined by Lift Coefficient
  (<code class="language-math">C_L</code>) like the following equation.
<pre><code class="language-math">
  L = \frac{1}{2} \rho v^2 S C_L

…and our module example.js contains:

import rehypeDocument from 'rehype-document'
import rehypeKatex from 'rehype-katex'
import rehypeParse from 'rehype-parse'
import rehypeStringify from 'rehype-stringify'
import {read, write} from 'to-vfile'
import {unified} from 'unified'

const file = await unified()
  .use(rehypeParse, {fragment: true})
  .use(rehypeDocument, {
    // Get the latest one from: <>.
    css: ''
  .process(await read('input.html'))

file.basename = 'output.html'
await write(file)

…then running node example.js creates an output.html with:

<!doctype html>
<html lang="en">
<meta charset="utf-8">
<meta content="width=device-width, initial-scale=1" name="viewport">
<link href="" rel="stylesheet">
  Lift(<span class="katex"><!--…--></span>) can be determined by Lift Coefficient
  (<span class="katex"><!--…--></span>) like the following equation.
<span class="katex-display"><!--…--></span>

…open output.html in a browser to see the rendered math.


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

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

Render elements with a language-math (or math-display, math-inline) class with KaTeX.

  • options (Options) — configuration

Transform (Transformer).


Configuration (TypeScript type).

import {KatexOptions} from 'katex'

type Options = Omit<KatexOptions, 'displayMode' | 'throwOnError'>

See Options on for more info.


This plugin supports the syntax extension enabled by remark-math. It also supports math generated by using fenced code:



The content of any element with a language-math, math-inline, or math-display class is transformed. The elements are replaced by what KaTeX renders. Either a math-display class or using <pre><code class="language-math"> will result in “display” math: math that is a centered block on its own line.


The HTML produced by KaTeX requires CSS to render correctly. You should use katex.css somewhere on the page where the math is shown to style it properly. At the time of writing, the last version is:

<!-- Get the latest one from: -->
<link rel="stylesheet" href="">


This package is fully typed with TypeScript. It exports the additional type Options.


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, rehype-katex@^7, compatible with Node.js 16.

This plugin works with unified version 6+ and rehype version 4+.


Assuming you trust KaTeX, using rehype-katex is safe. A vulnerability in it could open you to a cross-site scripting (XSS) attack. Be wary of user input and use rehype-sanitize.

When you don’t trust user content but do trust KaTeX, run rehype-katex after rehype-sanitize:

import rehypeKatex from 'rehype-katex'
import rehypeSanitize, {defaultSchema} from 'rehype-sanitize'
import rehypeStringify from 'rehype-stringify'
import remarkMath from 'remark-math'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import {unified} from 'unified'

const file = await unified()
  .use(rehypeSanitize, {
    attributes: {
      // The `language-*` regex is allowed by default.
      code: [['className', /^language-./, 'math-inline', 'math-display']]




See in remarkjs/.github for ways to get started. See 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

Package Sidebar


npm i rehype-katex

Weekly Downloads






Unpacked Size

15.7 kB

Total Files


Last publish


  • remcohaszing
  • johno
  • wooorm