![]() Summary: I've been experimenting with delivering a TrueType-only KaTeX build for our mobile apps. I couldn't get anything to render properly until I flipped the `format` specifier from `ttf` to `truetype`. Though I can't find a definitive source on this, all the examples I've seen online use `truetype` over `ttf`, and flipping from `ttf` to `truetype` fixed my own issues. It's unlikely that this has been much of a problem in practice, since so many browsers now support WOFF (I'm considering a TrueType-only build since it's the least common denominator across Android 4.3+ and mobile Safari). Test Plan: - To force TrueType rendering, comment out the `.use-eot`, `.use-woff2`, and `.use-woff` lines in `fonts.less`. - Run `make serve`. - Open up the demo page. - Verify that the demo text is rendered as before (only the parens are noticeably different in the demo?). Reviewers: kevinb, emily Reviewed By: emily Subscribers: benkomalo Differential Revision: https://phabricator.khanacademy.org/D29274 |
||
---|---|---|
build | ||
contrib/auto-render | ||
dockers | ||
metrics | ||
src | ||
static | ||
test | ||
.arcconfig | ||
.arclint | ||
.eslintrc | ||
.gitignore | ||
.travis.yml | ||
bower.json | ||
cli.js | ||
CONTRIBUTING.md | ||
katex.js | ||
LICENSE.txt | ||
lint_blacklist.txt | ||
Makefile | ||
package.json | ||
README.md | ||
release.sh | ||
server.js |
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="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
. Iftrue
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. Iffalse
the math will be rendered in inline mode. (default:false
)throwOnError
:boolean
. Iftrue
, KaTeX will throw aParseError
when it encounters an unsupported command. Iffalse
, KaTeX will render the unsupported command as text in the color given byerrorColor
. (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.