Integration of MathJax, KaTeX and Asymptote with scribble, to typeset math in Racket documentation
Go to file
Emily Eisenberg 10e9b4ec12 Add the ability to add woff2 files to the docker
Summary:
To complement pull request #142, add the ability to automatically
generate the woff2 files from within the docker. Add a script for copying out
the generated font files to make things easier. Remove the KaTeX_Greek font
files as well as the KaTeX_Win ones, since we don't use them and they're oddly
non-woff and non-eot specific?

Test Plan:
 - Build a new docker from the new Dockerfile
  - Make sure the woff2_compress program compiles
 - Follow the instructions in the README to build the fonts
  - Make sure the fonts correctly build
  - Make sure the copy_fonts.sh script copies the fonts out

Reviewers: alpert

Reviewed By: alpert

Differential Revision: http://phabricator.khanacademy.org/D13637
2014-10-05 22:52:40 -07:00
build Add a setup rule to Makefile 2013-07-30 13:54:43 -07:00
dockers Add the ability to add woff2 files to the docker 2014-10-05 22:52:40 -07:00
metrics Add skew and italic metrics for ttfs 2014-09-16 17:40:20 -07:00
src Add the ability to add woff2 files to the docker 2014-10-05 22:52:40 -07:00
static Add the ability to add woff2 files to the docker 2014-10-05 22:52:40 -07:00
test Add optional arguments 2014-10-01 14:20:47 -07:00
.arcconfig Rename everything to KaTeX 2013-07-10 14:08:50 -07:00
.gitignore Ignore NPM debug logs 2014-09-17 15:47:04 +02:00
.jshintrc Adds JSHint to the build system and tidies up code. 2014-10-01 21:28:46 -04:00
.travis.yml Enable travis-ci.org 2014-09-12 17:50:39 -07:00
cli.js Add simple CLI 2014-09-17 15:46:20 +02:00
CONTRIBUTING.md Merge pull request #107 from dbieber/patch-2 2014-09-24 11:28:21 -07:00
katex.js Warn when the website is in quirks mode 2014-09-17 15:13:56 -07:00
LICENSE.txt Add MIT License 2014-01-31 17:47:12 -08:00
lint_blacklist.txt Fix our parsing strategy so it is the same as (or very similar to) TeX's 2014-09-09 23:18:37 -07:00
Makefile Adds JSHint to the build system and tidies up code. 2014-10-01 21:28:46 -04:00
package.json Adds JSHint to the build system and tidies up code. 2014-10-01 21:28:46 -04:00
README.md Merge pull request #137 from cben/displaystyle 2014-10-01 15:06:02 -07:00
server.js Improve the fonts.less experience 2014-09-22 14:23:23 -07:00

KaTeX Build Status

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: KaTeXs layout is based on Donald Knuths 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

Download the built files from the releases page. Include the katex.min.js and katex.min.css files on your page:

<link rel="stylesheet" href="/path/to/katex.min.css">
<script src="/path/to/katex.min.js"></script>

Call katex.render with a TeX expression and a DOM element to render into:

katex.render("c = \\pm\\sqrt{a^2 + b^2}", element);

To generate HTML on the server, 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.

These APIs default to inline math typesetting; for display math you can prepend \displaystyle (#66):

katex.render("\\displaystyle " + formula, element);
// OR
var html = katex.renderToString("\\displaystyle " + formula);

Contributing

See CONTRIBUTING.md

License

KaTeX is licensed under the MIT License.