1
0
Fork 0
Add Math to your Markdown with a KaTeX plugin for Markdown-it. Forked from https://github.com/waylonflinn/markdown-it-katex
This repository has been archived on 2024-02-06. You can view files and clone it, but cannot push or open issues or pull requests.
Find a file
2016-03-11 08:01:19 -06:00
.gitignore add gitignore 2016-03-11 08:01:19 -06:00
browser.js initial commit 2016-03-11 07:56:48 -06:00
github-markdown.css initial commit 2016-03-11 07:56:48 -06:00
index.html initial commit 2016-03-11 07:56:48 -06:00
index.js initial commit 2016-03-11 07:56:48 -06:00
package.json initial commit 2016-03-11 07:56:48 -06:00
README.md initial commit 2016-03-11 07:56:48 -06:00

markdown-it-katex

Add Math to your Markdown

KaTeX is fast. This plugin makes it easy to support it in your markdown.

Usage

npm install markdown-it-katex

Include the KaTeX stylesheet in your html:

<link rel="stylesheet"href="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.3.0/katex.min.css">

If you're using the default markdown-it parser, I also recommend the github stylesheet: https://github.com/sindresorhus/github-markdown-css

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}$$

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