suzanne.soy/KaTeX
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Fast math typesetting for the web.
507 Commits 20 Branches 11 Tags 20 MiB
JavaScript 83.9%
Prolog 7.1%
Less 2.7%
Python 2.7%
Shell 1.5%
Other 2.1%
38ba9f9187
Go to file
Martin von Gagern 38ba9f9187 Serve files with and without babelify step 
As babelify is slow, it may be desriable to not run it during development.
This is OK if the browser is recent enough to understand ES6 natively.
(This does not include current Firefox due to it having problems with
for(const … in …), https://bugzilla.mozilla.org/show_bug.cgi?id=1094995.)
For older browsers, or to check issues possibly introduced by babelify,
adding /babel as the first component of the path will switch to a version
which has been processed by babelify.  This is also used for screenshots.
2017-01-13 22:37:17 -05:00
build Add a setup rule to Makefile 2013-07-30 13:54:43 -07:00
contrib/auto-render Turn var into const or let 2017-01-13 22:37:17 -05:00
dockers Serve files with and without babelify step 2017-01-13 22:37:17 -05:00
metrics Migrate to eslint 2015-12-01 10:02:08 -08:00
src Turn var into const or let 2017-01-13 22:37:17 -05:00
static Support \bmod, \pmod, \pod, and \mod. 2016-12-31 20:51:20 -05:00
test Serve files with and without babelify step 2017-01-13 22:37:17 -05: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
.babelrc Include babelify step in browserify calls 2017-01-13 22:37:17 -05:00
.eslintrc Turn var into const or let 2017-01-13 22:37:17 -05:00
.gitignore Add build artifacts to .gitignore and allow installing dependencies without building KaTeX 2016-11-02 21:24:59 -04:00
.travis.yml Check out test fonts in screenshotter.sh (#570) 2016-11-23 09:38:47 -05:00
bower.json Bump master to v0.8.0-pre 2017-01-06 19:50:50 -08:00
check-node-version.js Include babelify step in browserify calls 2017-01-13 22:37:17 -05:00
cli.js Turn var into const or let 2017-01-13 22:37:17 -05:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#553) 2016-11-02 22:02:47 -04:00
CONTRIBUTING.md Add a link to symbol/function support preview page 2015-10-20 16:25:02 +08:00
katex.js Turn var into const or let 2017-01-13 22:37:17 -05: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 Include babelify step in browserify calls 2017-01-13 22:37:17 -05:00
package.json Include babelify step in browserify calls 2017-01-13 22:37:17 -05:00
README.md README.md - added integrity (#590) 2017-01-13 12:15:28 +01:00
release.sh And make the release script actually work again. 2017-01-06 19:47:47 -08:00
server.js Serve files with and without babelify step 2017-01-13 22:37:17 -05:00

README.md

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: 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" integrity="sha384-wE+lCONuEo/QSfLb4AfrSk7HjWJtc4Xc1OiB2/aDBzHzjnlBP4SX7vjErTcwlA8C" crossorigin="anonymous">
<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.6.0/katex.min.js" integrity="sha384-tdtuPw3yx/rnUGmnLNWXtfjb9fpmwexsd+lr6HUYnUY4B7JhB5Ty7a1mYd+kto/s" crossorigin="anonymous"></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.