# markdown-it-katex > Fast math support for markdown-it with KaTeX Latest version **2.0.3** (published 2016-10-10) · MIT license · 0 weekly downloads ## Install ```sh npm install markdown-it-katex pnpm add markdown-it-katex yarn add markdown-it-katex bun add markdown-it-katex ``` ## Health **Score 0/100 (F)** — status: abandoned. Warnings: low downloads; no types; no esm support. Negative: high vulnerabilities; abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.3 | | Published | 2016-10-10 | | First published | 2016-03-11 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Known vulnerabilities | 1 | | Install scripts | no | | GitHub stars | 280 | | Author | waylonflinn@gmail.com | | Maintainers | waylonflinn | | Keywords | markdown, KaTeX, math, LaTeX, markdown-it-plugin, markdown-it | ## Links - npm: https://www.npmjs.com/package/markdown-it-katex - Repository: https://github.com/waylonflinn/markdown-it-katex - Homepage: https://github.com/waylonflinn/markdown-it-katex#readme - Issues: https://github.com/waylonflinn/markdown-it-katex/issues - npm.io page: https://npm.io/package/markdown-it-katex ## Dependencies (1) - [katex](https://npm.io/package/katex.md) ^0.6.0 ## Alternatives - [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads - [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads - [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads - [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads - [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads ## Recent versions - 2.0.3 (latest) — 2016-10-10 - 2.0.2 — 2016-10-10 - 2.0.1 — 2016-04-22 - 2.0.0 — 2016-04-22 - 1.1.0 — 2016-03-19 - 1.0.9 — 2016-03-11 - 1.0.8 — 2016-03-11 - 1.0.6 — 2016-03-11 - 1.0.5 — 2016-03-11 - 1.0.4 — 2016-03-11 - 1.0.3 — 2016-03-11 - 1.0.2 — 2016-03-11 - 1.0.1 — 2016-03-11 - 1.0.0 — 2016-03-11 ## README # markdown-it-katex Add Math to your Markdown [![Build Status](https://travis-ci.org/waylonflinn/markdown-it-katex.svg?branch=master)](https://travis-ci.org/waylonflinn/markdown-it-katex) [KaTeX](https://github.com/Khan/KaTeX) is a faster alternative to MathJax. This plugin makes it easy to support in your markdown. Need convincing? * Check out the comparative benchmark: [KaTeX vs MathJax](https://jsperf.com/katex-vs-mathjax/42) * Try it in your browser: [markdown-it-katex demo](http://waylonflinn.github.io/markdown-it-katex/) ## Usage Install markdown-it ``` npm install markdown-it ``` Install the plugin ``` npm install markdown-it-katex ``` Use it in your javascript ```javascript var md = require('markdown-it')(), mk = require('markdown-it-katex'); md.use(mk); // 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: ```html ``` If you're using the default markdown-it parser, I also recommend the [github stylesheet](https://github.com/sindresorhus/github-markdown-css): ```html ``` `KaTeX` options can be supplied with the second argument to use. ```javascript md.use(mk, {"throwOnError" : false, "errorColor" : " #cc0000"}); ``` ## Examples ### Inline Surround your LaTeX with a single `$` on each side for inline rendering. ``` $\sqrt{3x-1}+(1+x)^2$ ``` ### Block Use two (`$$`) for block rendering. This mode uses bigger symbols and centers the result. ``` $$\begin{array}{c} \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 \end{array}$$ ``` ## Syntax 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](https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX) --- _Source: https://npm.io/package/markdown-it-katex · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._