remark-math

This project is a monorepo that contains several packages for dealing with math in markdown and HTML.

Contents

• What is this?
• When should I use this?
• Examples
  • Example: KaTeX
  • Example: MathJax
• Security
• Contribute
• 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 plugin to support a math syntax in markdown
• rehype-katex — rehype plugin to render math in HTML with KaTeX
• 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.

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:

1Lift($$L$$) can be determined by Lift Coefficient ($$C_L$$) like the following
2equation.
3
4$$
5L = \frac{1}{2} \rho v^2 S C_L
6$$

…and our module example.js contains:

1import rehypeKatex from 'rehype-katex'
2import rehypeStringify from 'rehype-stringify'
3import remarkMath from 'remark-math'
4import remarkParse from 'remark-parse'
5import remarkRehype from 'remark-rehype'
6import {read} from 'to-vfile'
7import {unified} from 'unified'
8
9const file = await unified()
10  .use(remarkParse)
11  .use(remarkMath)
12  .use(remarkRehype)
13  .use(rehypeKatex)
14  .use(rehypeStringify)
15  .process(await read('example.md'))
16
17console.log(String(file))

…then running node example.js yields:

1<p>Lift(<code class="language-math math-inline"><span class="katex">…</span></code>) like the following
2equation.</p>
3<pre><code class="language-math math-display"><span class="katex-display"><span class="katex">…</span></span></code></pre>

👉 Note: KaTeX requires CSS to render correctly. Use katex.css somewhere on the page where the math is shown to style it properly:

1<!-- Get the latest one from: https://katex.org/docs/browser -->
2<link href="https://cdn.jsdelivr.net/npm/katex@0.16.8/dist/katex.min.css" rel="stylesheet">

Example: MathJax

Supporting either MathJax or KaTeX is very similar. Take the above KaTeX example and change:

1@@ -1,4 +1,4 @@
2-import rehypeKatex from 'rehype-katex'
3+import rehypeMathjax from 'rehype-mathjax'
4 import rehypeStringify from 'rehype-stringify'
5 import remarkMath from 'remark-math'
6 import remarkParse from 'remark-parse'
7@@ -10,7 +10,7 @@ const file = await unified()
8   .use(remarkParse)
9   .use(remarkMath)
10   .use(remarkRehype)
11-  .use(rehypeKatex)
12+  .use(rehypeMathjax)
13   .use(rehypeStringify)
14   .process(await read('example.md'))

…then running node example.js yields:

1<p>Lift(<mjx-container class="MathJax" jax="SVG"><!--…--></mjx-container>) can be determined by Lift Coefficient (<mjx-container class="MathJax" jax="SVG"><!--…--></mjx-container>) like the following
2equation.</p>
3<mjx-container class="MathJax" jax="SVG" display="true"><!--…--></mjx-container><style>
4mjx-container[jax="SVG"] {
5  direction: ltr;
6}
7/* … */
8</style>

Security

Assuming you trust KaTeX/MathJax, using rehype-katex/rehype-mathjax is safe. If a vulnerability is introduced in them, it opens you up to a cross-site scripting (XSS) attack. See their readmes for more info.

Contribute

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.

License

MIT © Junyoung Choi and TANIGUCHI Masaya