Fast math typesetting for the web.
Go to file
Emily Eisenberg f76688b639 Bump version to v0.1.0
Also ready KaTeX for releasing

Auditors: alpert
2014-09-15 03:04:11 -07:00
build Add a setup rule to Makefile 2013-07-30 13:54:43 -07:00
dockers Add a Dockerfile for huxley tests 2014-09-14 21:30:06 -07:00
metrics Move js files into src/ 2014-09-15 02:50:34 -07:00
src Move js files into src/ 2014-09-15 02:50:34 -07:00
static Rename katex.process to katex.render 2014-09-14 21:20:27 -07:00
test Move js files into src/ 2014-09-15 02:50:34 -07:00
.arcconfig Rename everything to KaTeX 2013-07-10 14:08:50 -07:00
.gitignore Somehow manage to fix the sizing bugs 2014-03-20 21:36:37 -04:00
.travis.yml Enable travis-ci.org 2014-09-12 17:50:39 -07:00
CONTRIBUTING.md Improve readme 2014-09-15 02:41:19 -07:00
katex.js Move js files into src/ 2014-09-15 02:50:34 -07:00
LICENSE.txt Add MIT License 2014-01-31 17:47:12 -08:00
lint_blacklist.txt Fix our parsing strategy so it is the same as (or very similar to) TeX's 2014-09-09 23:18:37 -07:00
Makefile Bump version to v0.1.0 2014-09-15 03:04:11 -07:00
package.json Bump version to v0.1.0 2014-09-15 03:04:11 -07:00
README.md Improve readme 2014-09-15 02:41:19 -07:00
server.js Improve testing 2014-09-12 13:30:30 -07:00

KaTeX Build Status

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: KaTeXs layout is based on Donald Knuths 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.

Usage

Download the built files from the releases page. Include the katex.min.js and katex.min.css files on your page:

<link rel="stylesheet" type="text/css" href="/path/to/katex.min.css">
<script src="/path/to/katex.min.js" type="text/javascript"></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);

To generate HTML on the server, 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.

Contributing

See CONTRIBUTING.md

License

KaTeX is licenced under the MIT License.