v0.8.0

KaTeX · Aug 12, 2017 · c800539 · c800539
1 parent d16d5df
commit c800539
Show file tree

Hide file tree

Showing 90 changed files with 12,038 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,6 @@ npm-debug.log
 last.png
 diff.png
 /.npm-install.stamp
-/dist/
 /test/screenshotter/tex/
 /test/screenshotter/diff/
 /test/symgroups.tex

diff --git a/README.md b/README.md
@@ -16,8 +16,8 @@ KaTeX supports all major browsers, including Chrome, Safari, Firefox, Opera, Edg
 You can [download KaTeX](https://github.com/khan/katex/releases) and host it on your server or include the `katex.min.js` and `katex.min.css` files on your page directly from a CDN:
 
 ```html
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/katex.min.css" integrity="sha384-wITovz90syo1dJWVh32uuETPVEtGigN07tkttEqPv+uR2SE/mbQcG7ATL28aI9H0" crossorigin="anonymous">
-<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/katex.min.js" integrity="sha384-/y1Nn9+QQAipbNQWU65krzJralCnuOasHncUFXGkdwntGeSvQicrYkiUBwsgUqc1" crossorigin="anonymous"></script>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.8.0/katex.min.css" integrity="sha384-BDqcjN11/6D69oC63ObubLHNvQR2fNjin6+AzxA3xalB0swTj17TxVV1tL1Q5Png" crossorigin="anonymous">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.8.0/katex.min.js" integrity="sha384-sKYm5us3z9/bRQA+cc3gPzqwI5RVgL8vJQx1lpBudr9IzHOR8fnFUH68dz1GsTQw" crossorigin="anonymous"></script>
 ```
 
 #### In-browser rendering

diff --git a/contrib/auto-render/README.md b/contrib/auto-render/README.md
@@ -10,7 +10,7 @@ This extension isn't part of KaTeX proper, so the script should be separately
 included in the page:
 
 ```html
-<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/contrib/auto-render.min.js" integrity="sha384-dq1/gEHSxPZQ7DdrM82ID4YVol9BYyU7GbWlIwnwyPzotpoc57wDw/guX8EaYGPx" crossorigin="anonymous"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.8.0/contrib/auto-render.min.js" integrity="sha384-RkgGHBDdR8eyBOoWeZ/vpGg1cOvSAJRflCUDACusAAIVwkwPrOUYykglPeqWakZu" crossorigin="anonymous"></script>
 ```
 
 Then, call the exposed `renderMathInElement` function in a script tag

diff --git a/dist/README.md b/dist/README.md
@@ -0,0 +1,94 @@
+# [<img src="https://khan.github.io/KaTeX/katex-logo.svg" width="130" alt="KaTeX">](https://khan.github.io/KaTeX/) [![Build Status](https://travis-ci.org/Khan/KaTeX.svg?branch=master)](https://travis-ci.org/Khan/KaTeX)
+
+[![Join the chat at https://gitter.im/Khan/KaTeX](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Khan/KaTeX?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+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 supports all major browsers, including Chrome, Safari, Firefox, Opera, Edge, and IE 9 - IE 11. A list of supported commands can be found on the [wiki](https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX).
+
+## Usage
+
+You can [download KaTeX](https://github.com/khan/katex/releases) and host it on your server or include the `katex.min.js` and `katex.min.css` files on your page directly from a CDN:
+
+```html
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.8.0/katex.min.css" integrity="sha384-BDqcjN11/6D69oC63ObubLHNvQR2fNjin6+AzxA3xalB0swTj17TxVV1tL1Q5Png" crossorigin="anonymous">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.8.0/katex.min.js" integrity="sha384-sKYm5us3z9/bRQA+cc3gPzqwI5RVgL8vJQx1lpBudr9IzHOR8fnFUH68dz1GsTQw" crossorigin="anonymous"></script>
+```
+
+#### In-browser rendering
+
+Call `katex.render` with a TeX expression and a DOM element to render into:
+
+```js
+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`:
+
+```js
+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`. If `true` the math will be rendered in display mode, which will put the math in display style (so `\int` and `\sum` are large, for example), and will center the math on the page on its own line. If `false` the math will be rendered in inline mode. (default: `false`)
+- `throwOnError`: `boolean`. If `true`, KaTeX will throw a `ParseError` when it encounters an unsupported command. If `false`, KaTeX will render the unsupported command as text in the color given by `errorColor`. (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`)
+- `macros`: `object`. A collection of custom macros. Each macro is a property with a name like `\name` (written `"\\name"` in JavaScript) which maps to a string that describes the expansion of the macro.
+- `colorIsTextColor`: `boolean`. If `true`, `\color` will work like LaTeX's `\textcolor`, and take two arguments (e.g., `\color{blue}{hello}`), which restores the old behavior of KaTeX (pre-0.8.0). If `false` (the default), `\color` will work like LaTeX's `\color`, and take one argument (e.g., `\color{blue}hello`).  In both cases, `\textcolor` works as in LaTeX (e.g., `\textcolor{blue}{hello}`).
+
+For example:
+
+```js
+katex.render("c = \\pm\\sqrt{a^2 + b^2}\\in\\RR", element, {
+  displayMode: true,
+  macros: {
+    "\\RR": "\\mathbb{R}"
+  }
+});
+```
+
+#### 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](contrib/auto-render/README.md) for more information.
+
+#### Font size and lengths
+
+By default, KaTeX math is rendered in a 1.21× larger font than the surrounding
+context, which makes super- and subscripts easier to read. You can control
+this using CSS, for example:
+
+```css
+.katex { font-size: 1.1em; }
+```
+
+KaTeX supports all TeX units, including absolute units like `cm` and `in`.
+Absolute units are currently scaled relative to the default TeX font size of
+10pt, so that `\kern1cm` produces the same results as `\kern2.845275em`.
+As a result, relative and absolute units are both uniformly scaled relative
+to LaTeX with a 10pt font; for example, the rectangle `\rule{1cm}{1em}` has
+the same aspect ratio in KaTeX as in LaTeX.  However, because most browsers
+default to a larger font size, this typically means that a 1cm kern in KaTeX
+will appear larger than 1cm in browser units.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## License
+
+KaTeX is licensed under the [MIT License](http://opensource.org/licenses/MIT).
diff --git a/dist/contrib/auto-render.min.js b/dist/contrib/auto-render.min.js
diff --git a/dist/fonts/KaTeX_AMS-Regular.eot b/dist/fonts/KaTeX_AMS-Regular.eot
diff --git a/dist/fonts/KaTeX_AMS-Regular.ttf b/dist/fonts/KaTeX_AMS-Regular.ttf
diff --git a/dist/fonts/KaTeX_AMS-Regular.woff b/dist/fonts/KaTeX_AMS-Regular.woff
diff --git a/dist/fonts/KaTeX_AMS-Regular.woff2 b/dist/fonts/KaTeX_AMS-Regular.woff2
diff --git a/dist/fonts/KaTeX_Caligraphic-Bold.eot b/dist/fonts/KaTeX_Caligraphic-Bold.eot
diff --git a/dist/fonts/KaTeX_Caligraphic-Bold.ttf b/dist/fonts/KaTeX_Caligraphic-Bold.ttf
diff --git a/dist/fonts/KaTeX_Caligraphic-Bold.woff b/dist/fonts/KaTeX_Caligraphic-Bold.woff
diff --git a/dist/fonts/KaTeX_Caligraphic-Bold.woff2 b/dist/fonts/KaTeX_Caligraphic-Bold.woff2
diff --git a/dist/fonts/KaTeX_Caligraphic-Regular.eot b/dist/fonts/KaTeX_Caligraphic-Regular.eot
diff --git a/dist/fonts/KaTeX_Caligraphic-Regular.ttf b/dist/fonts/KaTeX_Caligraphic-Regular.ttf
diff --git a/dist/fonts/KaTeX_Caligraphic-Regular.woff b/dist/fonts/KaTeX_Caligraphic-Regular.woff
diff --git a/dist/fonts/KaTeX_Caligraphic-Regular.woff2 b/dist/fonts/KaTeX_Caligraphic-Regular.woff2
diff --git a/dist/fonts/KaTeX_Fraktur-Bold.eot b/dist/fonts/KaTeX_Fraktur-Bold.eot
diff --git a/dist/fonts/KaTeX_Fraktur-Bold.ttf b/dist/fonts/KaTeX_Fraktur-Bold.ttf
diff --git a/dist/fonts/KaTeX_Fraktur-Bold.woff b/dist/fonts/KaTeX_Fraktur-Bold.woff
diff --git a/dist/fonts/KaTeX_Fraktur-Bold.woff2 b/dist/fonts/KaTeX_Fraktur-Bold.woff2
diff --git a/dist/fonts/KaTeX_Fraktur-Regular.eot b/dist/fonts/KaTeX_Fraktur-Regular.eot
diff --git a/dist/fonts/KaTeX_Fraktur-Regular.ttf b/dist/fonts/KaTeX_Fraktur-Regular.ttf
diff --git a/dist/fonts/KaTeX_Fraktur-Regular.woff b/dist/fonts/KaTeX_Fraktur-Regular.woff
diff --git a/dist/fonts/KaTeX_Fraktur-Regular.woff2 b/dist/fonts/KaTeX_Fraktur-Regular.woff2
diff --git a/dist/fonts/KaTeX_Main-Bold.eot b/dist/fonts/KaTeX_Main-Bold.eot
diff --git a/dist/fonts/KaTeX_Main-Bold.ttf b/dist/fonts/KaTeX_Main-Bold.ttf
diff --git a/dist/fonts/KaTeX_Main-Bold.woff b/dist/fonts/KaTeX_Main-Bold.woff
diff --git a/dist/fonts/KaTeX_Main-Bold.woff2 b/dist/fonts/KaTeX_Main-Bold.woff2
diff --git a/dist/fonts/KaTeX_Main-Italic.eot b/dist/fonts/KaTeX_Main-Italic.eot
diff --git a/dist/fonts/KaTeX_Main-Italic.ttf b/dist/fonts/KaTeX_Main-Italic.ttf
diff --git a/dist/fonts/KaTeX_Main-Italic.woff b/dist/fonts/KaTeX_Main-Italic.woff
diff --git a/dist/fonts/KaTeX_Main-Italic.woff2 b/dist/fonts/KaTeX_Main-Italic.woff2
diff --git a/dist/fonts/KaTeX_Main-Regular.eot b/dist/fonts/KaTeX_Main-Regular.eot
diff --git a/dist/fonts/KaTeX_Main-Regular.ttf b/dist/fonts/KaTeX_Main-Regular.ttf
diff --git a/dist/fonts/KaTeX_Main-Regular.woff b/dist/fonts/KaTeX_Main-Regular.woff
diff --git a/dist/fonts/KaTeX_Main-Regular.woff2 b/dist/fonts/KaTeX_Main-Regular.woff2
diff --git a/dist/fonts/KaTeX_Math-BoldItalic.eot b/dist/fonts/KaTeX_Math-BoldItalic.eot
diff --git a/dist/fonts/KaTeX_Math-BoldItalic.ttf b/dist/fonts/KaTeX_Math-BoldItalic.ttf
diff --git a/dist/fonts/KaTeX_Math-BoldItalic.woff b/dist/fonts/KaTeX_Math-BoldItalic.woff
diff --git a/dist/fonts/KaTeX_Math-BoldItalic.woff2 b/dist/fonts/KaTeX_Math-BoldItalic.woff2
diff --git a/dist/fonts/KaTeX_Math-Italic.eot b/dist/fonts/KaTeX_Math-Italic.eot
diff --git a/dist/fonts/KaTeX_Math-Italic.ttf b/dist/fonts/KaTeX_Math-Italic.ttf
diff --git a/dist/fonts/KaTeX_Math-Italic.woff b/dist/fonts/KaTeX_Math-Italic.woff
diff --git a/dist/fonts/KaTeX_Math-Italic.woff2 b/dist/fonts/KaTeX_Math-Italic.woff2
diff --git a/dist/fonts/KaTeX_Math-Regular.eot b/dist/fonts/KaTeX_Math-Regular.eot
diff --git a/dist/fonts/KaTeX_Math-Regular.ttf b/dist/fonts/KaTeX_Math-Regular.ttf
diff --git a/dist/fonts/KaTeX_Math-Regular.woff b/dist/fonts/KaTeX_Math-Regular.woff
diff --git a/dist/fonts/KaTeX_Math-Regular.woff2 b/dist/fonts/KaTeX_Math-Regular.woff2
diff --git a/dist/fonts/KaTeX_SansSerif-Bold.eot b/dist/fonts/KaTeX_SansSerif-Bold.eot
diff --git a/dist/fonts/KaTeX_SansSerif-Bold.ttf b/dist/fonts/KaTeX_SansSerif-Bold.ttf
diff --git a/dist/fonts/KaTeX_SansSerif-Bold.woff b/dist/fonts/KaTeX_SansSerif-Bold.woff
diff --git a/dist/fonts/KaTeX_SansSerif-Bold.woff2 b/dist/fonts/KaTeX_SansSerif-Bold.woff2
diff --git a/dist/fonts/KaTeX_SansSerif-Italic.eot b/dist/fonts/KaTeX_SansSerif-Italic.eot
diff --git a/dist/fonts/KaTeX_SansSerif-Italic.ttf b/dist/fonts/KaTeX_SansSerif-Italic.ttf
diff --git a/dist/fonts/KaTeX_SansSerif-Italic.woff b/dist/fonts/KaTeX_SansSerif-Italic.woff
diff --git a/dist/fonts/KaTeX_SansSerif-Italic.woff2 b/dist/fonts/KaTeX_SansSerif-Italic.woff2
diff --git a/dist/fonts/KaTeX_SansSerif-Regular.eot b/dist/fonts/KaTeX_SansSerif-Regular.eot
diff --git a/dist/fonts/KaTeX_SansSerif-Regular.ttf b/dist/fonts/KaTeX_SansSerif-Regular.ttf
diff --git a/dist/fonts/KaTeX_SansSerif-Regular.woff b/dist/fonts/KaTeX_SansSerif-Regular.woff
diff --git a/dist/fonts/KaTeX_SansSerif-Regular.woff2 b/dist/fonts/KaTeX_SansSerif-Regular.woff2
diff --git a/dist/fonts/KaTeX_Script-Regular.eot b/dist/fonts/KaTeX_Script-Regular.eot
diff --git a/dist/fonts/KaTeX_Script-Regular.ttf b/dist/fonts/KaTeX_Script-Regular.ttf
diff --git a/dist/fonts/KaTeX_Script-Regular.woff b/dist/fonts/KaTeX_Script-Regular.woff
diff --git a/dist/fonts/KaTeX_Script-Regular.woff2 b/dist/fonts/KaTeX_Script-Regular.woff2
diff --git a/dist/fonts/KaTeX_Size1-Regular.eot b/dist/fonts/KaTeX_Size1-Regular.eot
diff --git a/dist/fonts/KaTeX_Size1-Regular.ttf b/dist/fonts/KaTeX_Size1-Regular.ttf
diff --git a/dist/fonts/KaTeX_Size1-Regular.woff b/dist/fonts/KaTeX_Size1-Regular.woff
diff --git a/dist/fonts/KaTeX_Size1-Regular.woff2 b/dist/fonts/KaTeX_Size1-Regular.woff2
diff --git a/dist/fonts/KaTeX_Size2-Regular.eot b/dist/fonts/KaTeX_Size2-Regular.eot
diff --git a/dist/fonts/KaTeX_Size2-Regular.ttf b/dist/fonts/KaTeX_Size2-Regular.ttf
diff --git a/dist/fonts/KaTeX_Size2-Regular.woff b/dist/fonts/KaTeX_Size2-Regular.woff
diff --git a/dist/fonts/KaTeX_Size2-Regular.woff2 b/dist/fonts/KaTeX_Size2-Regular.woff2
diff --git a/dist/fonts/KaTeX_Size3-Regular.eot b/dist/fonts/KaTeX_Size3-Regular.eot
diff --git a/dist/fonts/KaTeX_Size3-Regular.ttf b/dist/fonts/KaTeX_Size3-Regular.ttf
diff --git a/dist/fonts/KaTeX_Size3-Regular.woff b/dist/fonts/KaTeX_Size3-Regular.woff
diff --git a/dist/fonts/KaTeX_Size3-Regular.woff2 b/dist/fonts/KaTeX_Size3-Regular.woff2
diff --git a/dist/fonts/KaTeX_Size4-Regular.eot b/dist/fonts/KaTeX_Size4-Regular.eot
diff --git a/dist/fonts/KaTeX_Size4-Regular.ttf b/dist/fonts/KaTeX_Size4-Regular.ttf
diff --git a/dist/fonts/KaTeX_Size4-Regular.woff b/dist/fonts/KaTeX_Size4-Regular.woff
diff --git a/dist/fonts/KaTeX_Size4-Regular.woff2 b/dist/fonts/KaTeX_Size4-Regular.woff2
diff --git a/dist/fonts/KaTeX_Typewriter-Regular.eot b/dist/fonts/KaTeX_Typewriter-Regular.eot
diff --git a/dist/fonts/KaTeX_Typewriter-Regular.ttf b/dist/fonts/KaTeX_Typewriter-Regular.ttf
diff --git a/dist/fonts/KaTeX_Typewriter-Regular.woff b/dist/fonts/KaTeX_Typewriter-Regular.woff
diff --git a/dist/fonts/KaTeX_Typewriter-Regular.woff2 b/dist/fonts/KaTeX_Typewriter-Regular.woff2