Skip to content
Fast math typesetting for the web.
JavaScript HTML CSS Other
Branch: master
Clone or download
xu-cheng and kevinbarabash libs.md: add Rust library (#2195)
Add a mention to the Rust library <https://github.com/xu-cheng/katex-rs> in the document.

Co-authored-by: Kevin Barabash <kevinb7@gmail.com>
Latest commit d6a4379 Feb 22, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Upgrade minimum development Node version to v10 (#2177) Jan 6, 2020
.github/ISSUE_TEMPLATE Add issue templates (#1862) Mar 24, 2019
contrib Add "option" to ignoredTags (#2180) Dec 24, 2019
dockers Load fonts before running screenshotter (#1891) Apr 7, 2019
docs libs.md: add Rust library (#2195) Feb 22, 2020
flow-typed/npm Port katex-a11y.js to KaTeX (#2062) Aug 2, 2019
src Fix delimiter error message (#2186) Jan 4, 2020
static Re includegraphics (#2053) Jul 21, 2019
submodules Update fonts: remove unused glyphs and Macintosh table (#2171) Feb 21, 2020
test Fix delimiter error message (#2186) Jan 4, 2020
website Add HTML extension (#2082) Dec 1, 2019
.browserslistrc Drop IE 9/10 support (#2136) Nov 1, 2019
.codecov.yml add .codecov.yml and disable patch coverage (#1164) Feb 17, 2018
.eslintignore Add mhchem extension (#1436) Nov 24, 2018
.eslintrc Disable eslint jest environment in non-test files (#2104) Oct 3, 2019
.flowconfig Port katex-a11y.js to KaTeX (#2062) Aug 2, 2019
.gitattributes Set up a diff attribute and textconv instructions for font files Jan 19, 2017
.gitignore Include extensions mhchem & copy-tex in home-page (#1932) Apr 29, 2019
.gitmodules Add unicode-fonts as submodule (#1182) Mar 6, 2018
.prettierrc Port katex-a11y.js to KaTeX (#2062) Aug 2, 2019
.stylelintrc Use local built CSS and fonts for master documentation (#1584) Aug 10, 2018
CHANGELOG.md Release v0.11.1 (#2098) Sep 18, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#553) Nov 3, 2016
CONTRIBUTING.md Move \global and \def to functions (#2138) Dec 5, 2019
LICENSE Update LICENSE and website to acknowledge individual copyrights as we… Nov 1, 2019
README.md Drop IE 9/10 support (#2136) Nov 1, 2019
babel.config.js Disable @babel/env debug (#1874) Mar 16, 2019
bower.json Replace Khan/KaTeX with KaTeX/KaTeX (#1781) Nov 20, 2018
cli.js leqno and fleqn support (#1814) Jan 29, 2019
katex.js Remove indexOf & textContent polyfill for IE 8 (#1645) Aug 20, 2018
katex.webpack.js Generate ECMAScript module for contrib (#1624) Oct 31, 2018
package.json Drop IE 9/10 support (#2136) Nov 1, 2019
release.sh Replace Khan/KaTeX with KaTeX/KaTeX (#1781) Nov 20, 2018
rollup.config.js Generate ECMAScript module for contrib (#1624) Oct 31, 2018
update-sri.js Replace Khan/KaTeX with KaTeX/KaTeX (#1781) Nov 20, 2018
wallaby.js Port katex-a11y.js to KaTeX (#2062) Aug 2, 2019
webpack.analyze.js Lint webpack.*.js (#1467) Jul 7, 2018
webpack.common.js Port katex-a11y.js to KaTeX (#2062) Aug 2, 2019
webpack.config.js enforce consistent object brace spacing (#1376) May 28, 2018
webpack.dev.js enforce consistent object brace spacing (#1376) May 28, 2018
yarn.lock [Security] Bump codecov from 3.2.0 to 3.6.5 (#2202) Feb 21, 2020

README.md

KaTeX

npm CircleCI codecov Join the chat at https://gitter.im/KaTeX/KaTeX Dependabot Status jsDelivr

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 is compatible with all major browsers, including Chrome, Safari, Firefox, Opera, Edge, and IE 11.

KaTeX supports much (but not all) of LaTeX and many LaTeX packages. See the list of supported functions.

Try out KaTeX on the demo page!

Getting started

Starter template

<!DOCTYPE html>
<!-- KaTeX requires the use of the HTML5 doctype. Without it, KaTeX may not render properly -->
<html>
  <head>
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/katex.min.css" integrity="sha384-zB1R0rpPzHqg7Kpt0Aljp8JPLqbXI3bhnPWROx27a9N0Ll6ZP/+DiW/UqRcLbRjq" crossorigin="anonymous">

    <!-- The loading of KaTeX is deferred to speed up page rendering -->
    <script defer src="https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/katex.min.js" integrity="sha384-y23I5Q6l+B6vatafAwxRu/0oK/79VlbSz7Q9aiSZUvyWYIYsd+qj+o24G5ZU2zJz" crossorigin="anonymous"></script>

    <!-- To automatically render math in text elements, include the auto-render extension: -->
    <script defer src="https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/contrib/auto-render.min.js" integrity="sha384-kWPLUVMOks5AQFrykwIup5lo0m3iMkkHrD0uJ4H5cjeGihAutqP0yW0J6dpFiVkI" crossorigin="anonymous"
        onload="renderMathInElement(document.body);"></script>
  </head>
  ...
</html>

You can also download KaTeX and host it yourself.

For details on how to configure auto-render extension, refer to the documentation.

API

Call katex.render to render a TeX expression directly into a DOM element. For example:

katex.render("c = \\pm\\sqrt{a^2 + b^2}", element, {
    throwOnError: false
});

Call katex.renderToString to generate an HTML string of the rendered math, e.g., for server-side rendering. For example:

var html = katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}", {
    throwOnError: false
});
// '<span class="katex">...</span>'

Make sure to include the CSS and font files in both cases. If you are doing all rendering on the server, there is no need to include the JavaScript on the client.

The examples above use the throwOnError: false option, which renders invalid inputs as the TeX source code in red (by default), with the error message as hover text. For other available options, see the API documentation, options documentation, and handling errors documentation.

Demo and Documentation

Learn more about using KaTeX on the website!

Contributing

See CONTRIBUTING.md

License

KaTeX is licensed under the MIT License.

You can’t perform that action at this time.