Fast math typesetting for the web.
Go to file
Martin von Gagern 0ebbc25672 Add build artifacts to .gitignore and allow installing dependencies without building KaTeX
* Let git ignore .npm-install.stamp and dist

The former is created for most makefile targets after dependencies have been
retrieved.  The latter is created by typical operations like “make” without
arguments or “npm install”.  Having these around is to be expected.

Adding this to .gitignore should NOT affect npm packaging, since that is
based on a whitelist in package.json which does mention dist.

* Allow installing dependencies without actually building KaTeX

We have been using “npm install” to install dependencies, but since that
also does build KaTeX itself, it may fail if e.g. there are any style guide
violations.  Now we only fetch dependencies but do not build KaTeX itself.

The make conditionals used here are not part of POSIX make but a GNU
extension.  But we already use functionality not mandated by POSIX (namely
many of the functions like “wildcard”), so this should not make portability
any worse than it already is.
2016-11-02 21:24:59 -04:00
build Add a setup rule to Makefile 2013-07-30 13:54:43 -07:00
contrib/auto-render Provide link to auto-render.min.js in usage example (#522) 2016-09-17 15:23:26 -07:00
dockers Fix texcmp issues related to bit depth and kerning (#549) 2016-10-22 19:37:18 -04:00
metrics Migrate to eslint 2015-12-01 10:02:08 -08:00
src Invalid input error message (#540) 2016-09-23 14:45:33 +02:00
static Add support for Latin-1, Cyrillic, and CJK characters inside \text{} (#508) 2016-08-01 17:51:40 -07:00
test Fix texcmp issues related to bit depth and kerning (#549) 2016-10-22 19:37:18 -04:00
.arcconfig Fix arc lint 2015-06-26 13:57:02 -07:00
.arclint Fix arc lint 2015-06-26 13:57:02 -07:00
.eslintrc Migrate to eslint 2015-12-01 10:02:08 -08:00
.gitignore Add build artifacts to .gitignore and allow installing dependencies without building KaTeX 2016-11-02 21:24:59 -04:00
.travis.yml Add support for Latin-1, Cyrillic, and CJK characters inside \text{} (#508) 2016-08-01 17:51:40 -07:00
bower.json Ignore release.sh in bower.json 2016-04-15 18:48:24 -07:00
cli.js Migrate to eslint 2015-12-01 10:02:08 -08:00
CONTRIBUTING.md Add a link to symbol/function support preview page 2015-10-20 16:25:02 +08:00
katex.js Migrate to eslint 2015-12-01 10:02:08 -08:00
LICENSE.txt Add basic auto-render extension 2015-04-01 15:57:10 -07:00
lint_blacklist.txt Blacklist dist/** so that ka-lint doesn't barf on those files 2016-04-15 18:11:31 -07:00
Makefile Add build artifacts to .gitignore and allow installing dependencies without building KaTeX 2016-11-02 21:24:59 -04:00
package.json Call “npm install” automatically if package.json changed (#505) 2016-08-23 18:05:50 -07:00
README.md Update CDN links to latest version (#478) 2016-05-23 11:42:27 -07:00
release.sh Make the release script correctly link to the new release page. 2016-04-15 18:30:31 -07:00
server.js Add support for Latin-1, Cyrillic, and CJK characters inside \text{} (#508) 2016-08-01 17:51:40 -07:00

KaTeX Build Status

Join the chat at https://gitter.im/Khan/KaTeX

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. 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. 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)
  • throwOnError: boolean. If true, KaTeX will throw a ParseError when it encounters an unsupported command. If false, KaTeX will render the unsupported command as text in the color given by errorColor. (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.