No Particular Method

# npm

Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

## @abreto/markdown-it-katex

3.2.0 • Public • Published

# markdown-it-katex

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

Need convincing?

## Usage

Install markdown-it

npm install markdown-it


Install the plugin

npm install @abreto/markdown-it-katex


Use it in your javascript

Include the KaTeX stylesheet in your html:

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

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

## Examples

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

## Keywords

### Install

npm i @abreto/markdown-it-katex

3

3.2.0

MIT

19.1 kB

9

### Repository

github.com/Abreto/markdown-it-katex