# remark-math
**Repository Path**: mirrors_remarkjs/remark-math
## Basic Information
- **Project Name**: remark-math
- **Description**: remark and rehype plugins to support math
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-09-25
- **Last Updated**: 2026-05-17
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# remark-math
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
This project is a monorepo that contains several packages for dealing with
math in markdown and HTML.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Examples](#examples)
* [Example: KaTeX](#example-katex)
* [Example: MathJax](#example-mathjax)
* [Security](#security)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This repository contains [unified][] ([rehype][] and [remark][]) plugins to add
support for math.
You can use them to add support for parsing and serializing a syntax extension
and to render math with KaTeX or MathJax.
* [`remark-math`][remark-math]
— remark plugin to support a math syntax in markdown
* [`rehype-katex`][rehype-katex]
— rehype plugin to render math in HTML with [KaTeX][]
* [`rehype-mathjax`][rehype-mathjax]
— rehype plugin to render math in HTML with [MathJax][]
When dealing with markdown, you optionally use `remark-math`, or alternatively
use fenced code (` ```math `).
Then, you either use `rehype-katex` or `rehype-mathjax` to render math in HTML.
There are also other plugins that work with `remark-math`.
Such as [`rehype-mathml`](https://github.com/Daiji256/rehype-mathml)
which uses [`ronkok/Temml`](https://github.com/ronkok/Temml).
## When should I use this?
This project is useful when you want to support LaTeX math.
This mechanism works well when you want authors, that have some LaTeX
experience, to be able to embed rich diagrams of math to scientific
documentation.
The extra syntax extension supported by `remark-math` for math in markdown does
not work everywhere so it makes markdown less portable.
This project is also useful as it renders math with KaTeX or MathJax at compile
time, which means that there is no client side JavaScript needed.
## Examples
### Example: KaTeX
Say our document `example.md` contains:
```markdown
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:
```js
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:
```html
Lift(…) like the following
equation.
…
```
> 👉 **Note**: KaTeX requires CSS to render correctly.
> Use `katex.css` somewhere on the page where the math is shown to style it
> properly:
>
> ```html
>
>
> ```
### Example: MathJax
Supporting either MathJax or KaTeX is very similar.
Take the above KaTeX example and change:
```diff
@@ -1,4 +1,4 @@
-import rehypeKatex from 'rehype-katex'
+import rehypeMathjax from 'rehype-mathjax'
import rehypeStringify from 'rehype-stringify'
import remarkMath from 'remark-math'
import remarkParse from 'remark-parse'
@@ -10,7 +10,7 @@ const file = await unified()
.use(remarkParse)
.use(remarkMath)
.use(remarkRehype)
- .use(rehypeKatex)
+ .use(rehypeMathjax)
.use(rehypeStringify)
.process(await read('example.md'))
```
…then running `node example.js` yields:
```html
Lift() can be determined by Lift Coefficient () like the following
equation.