Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iktakahiro/markdown-it-katex
Add Math to your Markdown with a KaTeX plugin for Markdown-it
https://github.com/iktakahiro/markdown-it-katex
Last synced: 3 months ago
JSON representation
Add Math to your Markdown with a KaTeX plugin for Markdown-it
- Host: GitHub
- URL: https://github.com/iktakahiro/markdown-it-katex
- Owner: iktakahiro
- License: other
- Fork: true (waylonflinn/markdown-it-katex)
- Created: 2018-03-06T05:37:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-30T11:01:32.000Z (about 2 years ago)
- Last Synced: 2024-07-01T09:26:51.918Z (4 months ago)
- Language: JavaScript
- Size: 233 KB
- Stars: 74
- Watchers: 6
- Forks: 32
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# markdown-it-katex
Add Math to your Markdown
[](https://travis-ci.org/iktakahiro/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)
## Usage
Install markdown-it
```bash
npm install markdown-it
```
Install the plugin
```bash
npm install @iktakahiro/markdown-it-katex
```
Use it in your javascript
```javascript
var md = require('markdown-it')(),
mk = require('@iktakahiro/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.
```latex
$\sqrt{3x-1}+(1+x)^2$
```
### Block
Use two (`$$`) for block rendering. This mode uses bigger symbols and centers
the result.
```latex
$$\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:
[Things that KaTeX does not (yet) support](https://github.com/KaTeX/KaTeX/wiki/Things-that-KaTeX-does-not-%28yet%29-support)