2f552af02d
Summary: Create our own screenshotting script which takes screenshots. This improves over huxley for a couple reasons: - It makes the screenshots the correct size (for some reason, huxley struggles with this). - Its configuration matches more with what we want (we don't need multiple screenshots or interaction, we just want a single static shot) - It runs faster I also changed the docs to reflect this change. Test Plan: - Make sure all of the tests that were in the Huxleyfile are now in ss_data.json - Run the screenshotter docker - Make sure all of the images look reasonable and don't change (except sometimes the Lap test, which has some strange pixel-positioning differences...) Reviewers: kevinb Reviewed By: kevinb Differential Revision: https://phabricator.khanacademy.org/D16731 |
||
|---|---|---|
| build | ||
| dockers | ||
| metrics | ||
| src | ||
| static | ||
| test | ||
| .arcconfig | ||
| .gitignore | ||
| .jshintrc | ||
| .travis.yml | ||
| cli.js | ||
| CONTRIBUTING.md | ||
| katex.js | ||
| LICENSE.txt | ||
| lint_blacklist.txt | ||
| Makefile | ||
| package.json | ||
| README.md | ||
| 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.
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="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.2.0/katex.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.2.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);
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.
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)
For example:
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element, { displayMode: true });
Contributing
See CONTRIBUTING.md
License
KaTeX is licensed under the MIT License.