KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web.
KaTeX supports all major browsers, including Chrome, Safari, Firefox, Opera, and IE 8 - IE 11. A list of supported commands can be on the wiki.
You can download KaTeX and host it on your server or include the katex.min.js
and katex.min.css
files on your page directly from a CDN:
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.6.0/katex.min.css"> <script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.6.0/katex.min.js"></script>
Call katex.render
with a TeX expression and a DOM element to render into:
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element);
If KaTeX can't parse the expression, it throws a katex.ParseError
error.
To generate HTML on the server or to generate an HTML string of the rendered math, you can use katex.renderToString
:
var html = katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}"); // '<span class="katex">...</span>'
Make sure to include the CSS and font files, but there is no need to include the JavaScript. Like render
, renderToString
throws if it can't parse the expression.
You can provide an object of options as the last argument to katex.render
and katex.renderToString
. Available options are:
displayMode
: boolean
. If true
the math will be rendered in display mode, which will put the math in display style (so \int
and \sum
are large, for example), and will center the math on the page on its own line. If false
the math will be rendered in inline mode. (default: false
)throwOnError
: boolean
. If true
, KaTeX will throw a ParseError
when it encounters an unsupported command. If false
, KaTeX will render the unsupported command as text in the color given by errorColor
. (default: true
)errorColor
: string
. A color string given in the format "#XXX"
or "#XXXXXX"
. This option determines the color which unsupported commands are rendered in. (default: #cc0000
)For example:
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element, { displayMode: true });
Math on the page can be automatically rendered using the auto-render extension. See the Auto-render README for more information.
See CONTRIBUTING.md
KaTeX is licensed under the MIT License.