Skip to content
Add Math to your Markdown with a KaTeX plugin for Markdown-it
Branch: master
Clone or download
Pull request Compare This branch is 28 commits ahead of waylonflinn:master.
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea Update .gitignore Jan 7, 2019
test Remove some test fixtures Mar 6, 2018
.gitignore Update .gitignore Jan 7, 2019
.travis.yml Update travis.yml Mar 6, 2018
LICENSE Add license information Mar 6, 2018 Update katex version to 0.10 Jan 7, 2019
browser.js initial commit Mar 11, 2016
index.html funnies Mar 11, 2016
index.js Update index.js Aug 14, 2018
package-lock.json Update katex version to 0.10 Jan 7, 2019
package.json Release 3.1.0 Jan 7, 2019


Add Math to your Markdown

Build Status

KaTeX is a faster alternative to MathJax. This plugin makes it easy to support in your markdown.

Need convincing?


Install markdown-it

npm install markdown-it

Install the plugin

npm install @iktakahiro/markdown-it-katex

Use it in your javascript

var md = require('markdown-it')(),
    mk = require('@iktakahiro/markdown-it-katex');


// double backslash is required for javascript strings, but not html input
var result = md.render('# Math Rulez! \n  $\\sqrt{3x-1}+(1+x)^2$');

Include the KaTeX stylesheet in your html:

<link rel="stylesheet" href="">

If you're using the default markdown-it parser, I also recommend the github stylesheet:

<link rel="stylesheet" href=""/>

KaTeX options can be supplied with the second argument to use.

md.use(mk, {"throwOnError" : false, "errorColor" : " #cc0000"});



Surround your LaTeX with a single $ on each side for inline rendering.



Use two ($$) for block rendering. This mode uses bigger symbols and centers the result.


\nabla \times \vec{\mathbf{B}} -\, \frac1c\, \frac{\partial\vec{\mathbf{E}}}{\partial t} &
= \frac{4\pi}{c}\vec{\mathbf{j}}    \nabla \cdot \vec{\mathbf{E}} & = 4 \pi \rho \\

\nabla \times \vec{\mathbf{E}}\, +\, \frac1c\, \frac{\partial\vec{\mathbf{B}}}{\partial t} & = \vec{\mathbf{0}} \\

\nabla \cdot \vec{\mathbf{B}} & = 0



Math parsing in markdown is designed to agree with the conventions set by pandoc:

Anything between two $ characters will be treated as TeX math. The opening $ must
have a non-space character immediately to its right, while the closing $ must
have a non-space character immediately to its left, and must not be followed
immediately by a digit. Thus, $20,000 and $30,000 won’t parse as math. If for some
reason you need to enclose text in literal $ characters, backslash-escape them and
they won’t be treated as math delimiters.

Math Syntax Support

KaTeX is based on TeX and LaTeX. Support for both is growing. Here's a list of currently supported functions:

Function Support in KaTeX

You can’t perform that action at this time.