e6de31d2d6
This adds a stamp file which is used to detect whether the `package.json` file got updated since the last `npm install`. If so, `npm install` is run again to update all modules to the version described in `package.json`. This happens as a dependency of only those modules which actually need some npm-installed module. Setting the corresponding make variable to the empty string disables the feature, which is used by the `make` invocation in the `prepublish` script inside `package.json` to avoid infinite loops. It can also be used by developers working in an environment with reduced connectivity, as long as they know what they are doing. |
||
|---|---|---|
| build | ||
| contrib/auto-render | ||
| dockers | ||
| metrics | ||
| src | ||
| static | ||
| test | ||
| .arcconfig | ||
| .arclint | ||
| .eslintrc | ||
| .gitignore | ||
| .travis.yml | ||
| bower.json | ||
| cli.js | ||
| CONTRIBUTING.md | ||
| katex.js | ||
| LICENSE.txt | ||
| lint_blacklist.txt | ||
| Makefile | ||
| package.json | ||
| README.md | ||
| release.sh | ||
| server.js | ||
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">
<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.6.0/katex.min.js"></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. Iftruethe math will be rendered in display mode, which will put the math in display style (so\intand\sumare large, for example), and will center the math on the page on its own line. Iffalsethe math will be rendered in inline mode. (default:false)throwOnError:boolean. Iftrue, KaTeX will throw aParseErrorwhen it encounters an unsupported command. Iffalse, KaTeX will render the unsupported command as text in the color given byerrorColor. (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.