9d3cdf694c
* Internal: Pass full `options` objects to makeSpan/makeSymbol. Not just the current color. This will facilitate applying options to built nodes in a standardized way, rather than changing all callsites. * Add style switching test: text and scriptstyle in the same group. * Apply style-specific spacing using different CSS coding. Specifically, infer style from a class on the *current* element, rather than the parent element. Use "mtight" class to denote elements with tight spacing (scriptstyle or scriptscriptstyle). Apply that class automatically based on options. * Fix #533, #534, #541. - #534: Implement getTypeOfGroup for font groups. - #533, #541: Improve the ways spaces are applied to lists. Since CSS adjacency implements mathematical spacing, it's incorrect to introduce "convenience spans" for spaces and display changes into the generated HTML -- those spans break adjacency. Apply display changes directly, and shift space spans into adjacent atoms. Requires updates to two screenshotter tests, LimitControls and SupSubLeftAlignReset. The new results for these tests are closer to TeX output than the old results. Also requires updates to Jasmine tests, since those assumed output structures that have changed. * Fix #136: Size commands generate fragments, not spans. This is so the size commands don't hide the types of their enclosed atoms. Addresses #136. This slightly changes the vertical position of the Sizing test. Not sure the vertical position matters, so change the test.
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 supports all major browsers, including Chrome, Safari, Firefox, Opera, and IE 8 - IE 11. A list of supported commands can be on the wiki.
Usage
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>
In-browser rendering
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.
Server side rendering or rendering to a string
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.
Rendering options
You can provide an object of options as the last argument to katex.render and katex.renderToString. Available options are:
displayMode:boolean. Iftruethe math will be rendered in display mode, which will put the math in display style (so\intand\sumare large, for example), and will center the math on the page on its own line. Iffalsethe math will be rendered in inline mode. (default:false)throwOnError:boolean. Iftrue, KaTeX will throw aParseErrorwhen it encounters an unsupported command. Iffalse, KaTeX will render the unsupported command as text in the color given byerrorColor. (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 });
Automatic rendering of math on a page
Math on the page can be automatically rendered using the auto-render extension. See the Auto-render README for more information.
Contributing
See CONTRIBUTING.md
License
KaTeX is licensed under the MIT License.