This is a mirror of https://github.com/Khan/KaTeX and for own development.

ylemkimon ce3840d4ce Include only necessary fonts for target environment specified by Browserslist (#1674) 11 months ago
.circleci 112582daa5 Replace Khan/KaTeX with KaTeX/KaTeX (#1781) 11 months ago
contrib 64745b5c8a Add mhchem extension (#1436) 11 months ago
dockers 11490b5e0b Allow screenshotter to be run on IE, Edge, Safari and remote, e.g., BrowserStack (#1661) 1 year ago
docs ce3840d4ce Include only necessary fonts for target environment specified by Browserslist (#1674) 11 months ago
src 64745b5c8a Add mhchem extension (#1436) 11 months ago
static fdb155aa97 Build ECMAScript modules (#1479) 1 year ago
submodules 74fb394bb5 Update fonts to remove \neq and \notin glyphs (#1499) 1 year ago
test 3dfd17d9b4 Add catcode to Lexer, move comment parsing back to Lexer (#1789) 11 months ago
website ec6a2b4f36 Remove Supported Functions onPageNav style (#1767) 11 months ago
.browserslistrc cd8e6e0de6 Add browserslist (#1662) 1 year ago
.codecov.yml 789aabe7a1 add .codecov.yml and disable patch coverage (#1164) 1 year ago
.eslintignore 64745b5c8a Add mhchem extension (#1436) 11 months ago
.eslintrc 4178639ea5 Upgrade to Babel 7 (#1595) 1 year ago
.flowconfig 237986a7ca Change build directory to `dist` and cleanup NPM scripts (#1500) 1 year ago
.gitattributes a3f0653e5c Set up a diff attribute and textconv instructions for font files 2 years ago
.gitignore b99de9ae68 Use local built CSS and fonts for master documentation (#1584) 1 year ago
.gitmodules 96ad6e0f4f Add unicode-fonts as submodule (#1182) 1 year ago
.stylelintrc b99de9ae68 Use local built CSS and fonts for master documentation (#1584) 1 year ago
CHANGELOG.md 112582daa5 Replace Khan/KaTeX with KaTeX/KaTeX (#1781) 11 months ago
CODE_OF_CONDUCT.md ace67541a0 Create CODE_OF_CONDUCT.md (#553) 3 years ago
CONTRIBUTING.md 112582daa5 Replace Khan/KaTeX with KaTeX/KaTeX (#1781) 11 months ago
LICENSE 9a9842886e Remove Object.assign() in auto-render which requires expensive polyfill, update LICENSE (#1591) 1 year ago
README.md 112582daa5 Replace Khan/KaTeX with KaTeX/KaTeX (#1781) 11 months ago
babel.config.js ce3840d4ce Include only necessary fonts for target environment specified by Browserslist (#1674) 11 months ago
bower.json 112582daa5 Replace Khan/KaTeX with KaTeX/KaTeX (#1781) 11 months ago
cli.js 3514d48856 cli's default maxSize should be Infinity, not 0 (#1739) 1 year ago
greenkeeper.json 6f0a76c3a5 Enable Greenkeeper on website/package.json (#1687) 1 year ago
katex.js 96310815c5 Remove indexOf & textContent polyfill for IE 8 (#1645) 1 year ago
katex.webpack.js f628ca142b Generate ECMAScript module for contrib (#1624) 1 year ago
package.json ce3840d4ce Include only necessary fonts for target environment specified by Browserslist (#1674) 11 months ago
release.sh 112582daa5 Replace Khan/KaTeX with KaTeX/KaTeX (#1781) 11 months ago
rollup.config.js f628ca142b Generate ECMAScript module for contrib (#1624) 1 year ago
update-sri.js 112582daa5 Replace Khan/KaTeX with KaTeX/KaTeX (#1781) 11 months ago
webpack.analyze.js 0fb71c8bf8 Lint webpack.*.js (#1467) 1 year ago
webpack.common.js ce3840d4ce Include only necessary fonts for target environment specified by Browserslist (#1674) 11 months ago
webpack.config.js e1614995e3 enforce consistent object brace spacing (#1376) 1 year ago
webpack.dev.js e1614995e3 enforce consistent object brace spacing (#1376) 1 year ago
yarn.lock ce3840d4ce Include only necessary fonts for target environment specified by Browserslist (#1674) 11 months ago

README.md

KaTeX

npm CircleCI codecov Greenkeeper badge 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 9–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.10.0/dist/katex.min.css" integrity="sha384-9eLZqc9ds8eNjO3TmqPeYcDj8n+Qfa4nuSiGYa6DjLNcv9BtN69ZIulL9+8CqC9Y" crossorigin="anonymous">

    <!-- The loading of KaTeX is deferred to speed up page rendering -->
    <script defer src="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/katex.min.js" integrity="sha384-K3vbOmF2BtaVai+Qk37uypf7VrgBubhQreNQe9aGsz9lB63dIFiQVlJbr92dw2Lx" 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.10.0/dist/contrib/auto-render.min.js" integrity="sha384-kmZOZB5ObwgQnS/DuDg6TScgOiWWBiVt0plIRkZCmE6rDZGrEOQeHM5PcHi+nyqe" 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.