Fast math support for markdown-it with KaTeX
npm install @traptitech/markdown-it-katexAdd KaTeX rendering to your Markdown
shell
$ npm install @traptitech/markdown-it-katex
`Including KaTeX CSS is needed.
$3
- : You can change KaTeX version by passing the instance.
- blockClass: Class added to KaTeX block.
- Any KaTeX Options`js
md.use(mk, {"blockClass": "math-block", "errorColor" : " #cc0000"});
`Examples
$3
Surround your LaTeX with a single on each side for inline rendering.
`
$\sqrt{3x-1}+(1+x)^2$
$3
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}$$
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.
KaTeX is based on TeX and LaTeX. Support for both is growing. Here's a list of
currently supported functions: