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) | 5 years ago | |
---|---|---|
.circleci | 5 years ago | |
contrib | 5 years ago | |
dockers | 6 years ago | |
docs | 5 years ago | |
src | 5 years ago | |
static | 6 years ago | |
submodules | 6 years ago | |
test | 5 years ago | |
website | 5 years ago | |
.browserslistrc | 6 years ago | |
.codecov.yml | 6 years ago | |
.eslintignore | 5 years ago | |
.eslintrc | 6 years ago | |
.flowconfig | 6 years ago | |
.gitattributes | 7 years ago | |
.gitignore | 6 years ago | |
.gitmodules | 6 years ago | |
.stylelintrc | 6 years ago | |
CHANGELOG.md | 5 years ago | |
CODE_OF_CONDUCT.md | 8 years ago | |
CONTRIBUTING.md | 5 years ago | |
LICENSE | 6 years ago | |
README.md | 5 years ago | |
babel.config.js | 5 years ago | |
bower.json | 5 years ago | |
cli.js | 6 years ago | |
greenkeeper.json | 6 years ago | |
katex.js | 6 years ago | |
katex.webpack.js | 6 years ago | |
package.json | 5 years ago | |
release.sh | 5 years ago | |
rollup.config.js | 6 years ago | |
update-sri.js | 5 years ago | |
webpack.analyze.js | 6 years ago | |
webpack.common.js | 5 years ago | |
webpack.config.js | 6 years ago | |
webpack.dev.js | 6 years ago | |
yarn.lock | 5 years ago |
KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web.
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!
<!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.
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.
Learn more about using KaTeX on the website!
See CONTRIBUTING.md
KaTeX is licensed under the MIT License.