- Notifications
You must be signed in to change notification settings - Fork1.2k
Fast math typesetting for the web.
License
KaTeX/KaTeX
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
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 inthis 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 thelist of supported functions.
Try out KaTeXon the demo page!
<!DOCTYPE html><!-- KaTeX requires the use of the HTML5 doctype. Without it, KaTeX may not render properly --><html><head><linkrel="stylesheet"href="https://cdn.jsdelivr.net/npm/katex@0.16.21/dist/katex.min.css"integrity="sha384-zh0CIslj+VczCZtlzBcjt5ppRcsAmDnRem7ESsYwWwg3m/OaJ2l4x7YBZl9Kxxib"crossorigin="anonymous"><!-- The loading of KaTeX is deferred to speed up page rendering --><scriptdefersrc="https://cdn.jsdelivr.net/npm/katex@0.16.21/dist/katex.min.js"integrity="sha384-Rma6DA2IPUwhNxmrB/7S3Tno0YY7sFu9WSYMCuulLhIqYSGZ2gKCJWIqhBWqMQfh"crossorigin="anonymous"></script><!-- To automatically render math in text elements, include the auto-render extension: --><scriptdefersrc="https://cdn.jsdelivr.net/npm/katex@0.16.21/dist/contrib/auto-render.min.js"integrity="sha384-hCXGrW6PitJEwbkoStFjeJxv+fSOOQKOPbJxSfM6G5sWZjAyWhXiTIIAmQqnlLlh"crossorigin="anonymous"onload="renderMathInElement(document.body);"></script></head> ...</html>
You can alsodownload KaTeX and host it yourself.
For details on how to configure auto-render extension, refer tothe documentation.
Callkatex.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});
Callkatex.renderToString to generate an HTML string of the rendered math,e.g., for server-side rendering. For example:
varhtml=katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}",{throwOnError:false});// '<span>...</span>'
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 theJavaScript on the client.
The examples above use thethrowOnError: false option, which renders invalidinputs as the TeX source code in red (by default), with the error message ashover text. For other available options, see theAPI documentation,options documentation, andhandling errors documentation.
Learn more about using KaTeXon the website!
This project exists thanks to all the people who contribute code. If you'd like to help, seeour guide to contributing code.
Become a financial contributor and help us sustain our community.
Support this project with your organization. Your logo will show up here with a link to your website.
KaTeX is licensed under theMIT License.
About
Fast math typesetting for the web.
