Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fast math typesetting for the web.
JavaScript Perl CSS Python HTML Makefile Other

Merge pull request #340 from gagern/pngRepack

Use jspngopt and pako to create reproducible PNG files for Chrome as well
latest commit f488a7c48d
@kevinb7 kevinb7 authored
Failed to load latest commit information.
build Add a setup rule to Makefile
contrib/auto-render [auto-render] Don't stop parsing when one expression fails
dockers Use jspngopt and pako to create reproducible PNG files for Chrome as …
metrics Add missing semicolon at the end of fontMetricsData
src Merge pull request #330 from xymostech/add-vert-separator
static Add | column separators to arrays.
test Use jspngopt and pako to create reproducible PNG files for Chrome as …
.arcconfig Fix `arc lint`
.arclint Fix `arc lint`
.gitignore Add tool to check symbol group types against LaTeX
.jshintrc Add JSON as a global in .jshintrc
.travis.yml Enable travis-ci.org
CONTRIBUTING.md add a link to Examining TeX page on wiki to CONTRIBUTING.md
LICENSE.txt Add basic auto-render extension
Makefile Generate fontMetricsData as JavaScript
README.md Revert "Add a Gitter chat badge to README.md"
bower.json Update master version numbers
cli.js Add display mode to the CLI
katex.js Expose a new .__parse() method for generating a parse tree from a mat…
lint_blacklist.txt Fix our parsing strategy so it is the same as (or very similar to) TeX's
package.json Use jspngopt and pako to create reproducible PNG files for Chrome as …
server.js Automatically start a development server

README.md

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: 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. 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)
  • breakOnUnsupportedCmds: boolean. If true, KaTeX will generate a ParseError when it encounters an unsupported command. If false, KaTeX will render the 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.

Something went wrong with that request. Please try again.