Fast math typesetting for the web.
Go to file
Kevin Barabash 1573e1eed6 Add a build step to generate extended metrics that additionally contain glyph widths
Summary:
The ability to use pre-determined character widths will benefit alternative
layout engines such as gagern's canvas layout engine.  I would also like to
experiment would using CSS transforms to absolutely position each glyph.  This
diff adds a new make rule, make extended_metrics, which generates metrics that
also containing glyph widths.

Test Plan:
- run `make extended_metrics`
- verify that fontMetricsData.js contains entries with 5 numbers instead of 4

Reviewers: emily alpert
2015-10-16 14:31:08 -07:00
build Add a setup rule to Makefile 2013-07-30 13:54:43 -07:00
contrib/auto-render [auto-render] Don't stop parsing when one expression fails 2015-04-26 17:04:11 -07:00
dockers Use jspngopt and pako to create reproducible PNG files for Chrome as well 2015-08-30 02:12:55 +02:00
metrics Add a build step to generate extended metrics that additionally contain glyph widths 2015-10-16 14:31:08 -07:00
src Add a build step to generate extended metrics that additionally contain glyph widths 2015-10-16 14:31:08 -07:00
static Remove 3px border around rules. 2015-09-22 10:21:33 -07:00
test Rewrote lexer, avoiding some mode-specific distinctions 2015-10-02 20:06:03 +02: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
.gitignore Add tool to check symbol group types against LaTeX 2015-08-19 22:56:41 +02:00
.jshintrc Add JSON as a global in .jshintrc 2015-04-26 17:22:42 -07:00
.travis.yml Enable travis-ci.org 2014-09-12 17:50:39 -07:00
bower.json Update master version numbers 2015-07-16 14:20:29 -07:00
cli.js Add display mode to the CLI 2015-06-10 07:15:53 -07:00
CONTRIBUTING.md Redirect people to gitter instead of freenode 2015-09-25 14:35:23 -07:00
katex.js Expose a new .__parse() method for generating a parse tree from a math expression. 2015-05-04 15:59:18 -04:00
LICENSE.txt Add basic auto-render extension 2015-04-01 15:57:10 -07: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 Add a build step to generate extended metrics that additionally contain glyph widths 2015-10-16 14:31:08 -07:00
package.json Use jspngopt and pako to create reproducible PNG files for Chrome as well 2015-08-30 02:12:55 +02:00
README.md Add Gitter badge 2015-09-25 21:28:31 +00:00
server.js Automatically start a development server 2015-07-15 15:41:29 +02: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="//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. 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.