![]() Since the Selenium images are available for download, and downloading them is usually faster than building them from scratch, this makes taking screenshots easier. Furthermore, since the Selenium image is not specific to KaTeX, it could as well be used for other purposes, thus saving space since a single image can be used in multiple projects. This change also deals with the non-determinism in the Lap screenshot: We detect the one known (and accepted) alternate rendering and change the output file name to Lap_alt in this case. So either Lap or Lap_alt gets saved to, and if the image is different from both, then one of these files will show a modification. On the other hand, if it is equal to either of these, then the matching one will get overwritten, showing no change. |
||
---|---|---|
build | ||
contrib/auto-render | ||
dockers | ||
metrics | ||
src | ||
static | ||
test | ||
.arcconfig | ||
.arclint | ||
.gitignore | ||
.jshintrc | ||
.travis.yml | ||
bower.json | ||
cli.js | ||
CONTRIBUTING.md | ||
katex.js | ||
LICENSE.txt | ||
lint_blacklist.txt | ||
Makefile | ||
package.json | ||
README.md | ||
server.js |
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="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.3.0/katex.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.3.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
. Iftrue
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. Iffalse
the math will be rendered in inline mode. (default:false
)
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.