mirror of
https://github.com/Smaug123/KaTeX
synced 2025-10-08 04:28:41 +00:00
293af2936d
* Release v0.10.0-rc Bump master to v0.10.0-pre * Update CHANGELOG.md * Update SRI hashes * Update SRI hashes
91 lines
4.5 KiB
Markdown
91 lines
4.5 KiB
Markdown
# [<img src="https://cdn.rawgit.com/Khan/KaTeX/84189cd3adae24d92e766d14eb80d6e54f3c7dca/katex-logo.svg" width="130" alt="KaTeX">](https://khan.github.io/KaTeX/)
|
||
[](https://www.npmjs.com/package/katex)
|
||
[](https://circleci.com/gh/Khan/KaTeX)
|
||
[](https://codecov.io/gh/Khan/KaTeX)
|
||
[](https://gitter.im/Khan/KaTeX?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://greenkeeper.io/)
|
||
[](https://www.jsdelivr.com/package/npm/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](http://www.intmath.com/cg5/katex-mathjax-comparison.php).
|
||
* **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](https://khan.github.io/KaTeX/docs/supported.html).
|
||
|
||
Try out KaTeX [on the demo page](https://khan.github.io/KaTeX/#demo)!
|
||
|
||
## Getting started
|
||
|
||
### Starter template
|
||
|
||
```html
|
||
<!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-rc/dist/katex.min.css" integrity="sha384-D+9gmBxUQogRLqvARvNLmA9hS2x//eK1FhVb9PiU86gmcrBrJAQT8okdJ4LMp2uv" 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-rc/dist/katex.min.js" integrity="sha384-HfSid88/k05FhUa2Qk7I3hgXARcblhK5ec5QB5hA4LGHh5+oqtrwKN9Ad5Rb8iZQ" 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-rc/dist/contrib/auto-render.min.js" integrity="sha384-yACMu8JWxKzSp/C1YV86pzGiQ/l1YUfE8oPuahJQxzehAjEt2GiQuy/BIvl9KyeF" crossorigin="anonymous"
|
||
onload="renderMathInElement(document.body);"></script>
|
||
</head>
|
||
...
|
||
</html>
|
||
```
|
||
|
||
You can also [download KaTeX](https://github.com/khan/katex/releases) and host it yourself.
|
||
|
||
For details on how to configure auto-render extension, refer to [the documentation](https://khan.github.io/KaTeX/docs/autorender.html).
|
||
|
||
### API
|
||
|
||
Call `katex.render` to render a TeX expression directly into a DOM element.
|
||
For example:
|
||
|
||
```js
|
||
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:
|
||
|
||
```js
|
||
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](https://khan.github.io/KaTeX/docs/api.html),
|
||
[options documentation](https://khan.github.io/KaTeX/docs/options.html), and
|
||
[handling errors documentation](https://khan.github.io/KaTeX/docs/error.html).
|
||
|
||
## Demo and Documentation
|
||
|
||
Learn more about using KaTeX [on the website](https://khan.github.io/KaTeX)!
|
||
|
||
## Contributing
|
||
|
||
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
||
|
||
## License
|
||
|
||
KaTeX is licensed under the [MIT License](http://opensource.org/licenses/MIT).
|