Need help with KaTeX?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

KaTeX
13.7K Stars 942 Forks MIT License 1.7K Commits 285 Opened issues

Description

Fast math typesetting for the web.

!
?

Contributors list

KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web.

• Fast: KaTeX renders its math synchronously and doesn't need to reflow the page. See how it compares to a competitor in this speed test.
• Print quality: KaTeX's layout is based on Donald Knuth's TeX, the gold standard for math typesetting.
• Self contained: KaTeX has no dependencies and can easily be bundled with your website resources.
• Server side rendering: KaTeX produces the same output regardless of browser or environment, so you can pre-render expressions using Node.js and send them as plain HTML.

KaTeX is compatible with all major browsers, including Chrome, Safari, Firefox, Opera, Edge, and IE 11.

KaTeX supports much (but not all) of LaTeX and many LaTeX packages. See the list of supported functions.

Try out KaTeX on the demo page!

Getting started

Starter template

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-r/BYDnh2ViiCwqZt5VJVWuADDic3NnnTIEOv4hOh05nSfB6tjWpKmn1kUHOVkMXc" crossorigin="anonymous">

<!-- The loading of KaTeX is deferred to speed up page rendering -->
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js" integrity="sha384-zDIgORxjImEWftZXZpWLs2l57fMX9B3yWFPN5Ecabe211Hm5ZG/OIz2b07DYPUcH" crossorigin="anonymous"></script>

<!-- To automatically render math in text elements, include the auto-render extension: -->
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js" integrity="sha384-vZTG03m+2yp6N6BNi5iM4rW4oIwk5DfcNdFfxkk9ZWpDriOkXX8voJBFrAO7MpVl" crossorigin="anonymous" onload="renderMathInElement(document.body);"></script>
...


For details on how to configure auto-render extension, refer to the documentation.

API

Call

katex.render
to render a TeX expression directly into a DOM element. For example:
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element, {
throwOnError: false
});


Call

katex.renderToString
to generate an HTML string of the rendered math, e.g., for server-side rendering. For example:
var html = katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}", {
throwOnError: false
});
// '...'


Make sure to include the CSS and font files in both cases. If you are doing all rendering on the server, there is no need to include the JavaScript on the client.

The examples above use the

throwOnError: false
option, which renders invalid inputs as the TeX source code in red (by default), with the error message as hover text. For other available options, see the API documentation, options documentation, and handling errors documentation.