Fast math typesetting for the web.
Go to file
Ben Alpert 2349a1ed85 Merge pull request #127 from kevinb7/contrib_style_decls
Added rule to the style guide section for where to declare variables
2015-03-01 18:27:21 -08:00
build Add a setup rule to Makefile 2013-07-30 13:54:43 -07:00
dockers Add the ability to add woff2 files to the docker 2014-10-05 22:52:40 -07:00
metrics Fix up small problems with #126 2015-02-18 16:28:05 -08:00
src Add an optional settings argument to render calls 2015-02-19 15:26:57 -08:00
static Add an optional settings argument to render calls 2015-02-19 15:26:57 -08:00
test Add an optional settings argument to render calls 2015-02-19 15:26:57 -08:00
.arcconfig update .arcconfig to https 2014-11-21 15:41:38 -08:00
.gitignore Ignore NPM debug logs 2014-09-17 15:47:04 +02:00
.jshintrc Adds JSHint to the build system and tidies up code. 2014-10-01 21:28:46 -04:00
.travis.yml Enable travis-ci.org 2014-09-12 17:50:39 -07:00
cli.js Add simple CLI 2014-09-17 15:46:20 +02:00
CONTRIBUTING.md added rule to the style guide section for where to declare variables 2014-09-25 14:32:37 -06:00
katex.js Add an optional settings argument to render calls 2015-02-19 15:26:57 -08: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 Make build/katex.less.css depend on static/fonts.less 2014-11-03 18:55:57 -08:00
package.json Release 0.1.1 2014-10-15 18:09:04 -07:00
README.md Add an optional settings argument to render calls 2015-02-19 15:26:57 -08:00
server.js Improve the fonts.less experience 2014-09-22 14:23:23 -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

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.1.1/katex.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.1.1/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);

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.

Rendering options

You can provide an object of options as the last argument to katex.render and katex.renderToString. Available options are:

  • displayMode: boolean. If true 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. If false the math will be rendered in inline mode. (default: false)

For example:

katex.render("c = \\pm\\sqrt{a^2 + b^2}", element, { displayMode: true });

Contributing

See CONTRIBUTING.md

License

KaTeX is licensed under the MIT License.