-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
77 changed files
with
658 additions
and
909 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,10 @@ | ||
| # [<img src="https://khan.github.io/KaTeX/katex-logo.svg" width="130" alt="KaTeX">](https://khan.github.io/KaTeX/) | ||
| [](https://travis-ci.org/Khan/KaTeX) | ||
| # [<img src="https://cdn.rawgit.com/Khan/KaTeX/84189cd3adae24d92e766d14eb80d6e54f3c7dca/katex-logo.svg" width="130" alt="KaTeX">](https://katex.org/) | ||
| [](https://www.npmjs.com/package/katex) | ||
| [](https://circleci.com/gh/Khan/KaTeX) | ||
| [](https://codecov.io/gh/Khan/KaTeX) | ||
| [](https://gitter.im/Khan/KaTeX?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
| [](https://gitter.im/Khan/KaTeX?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://greenkeeper.io/) | ||
| [](https://www.jsdelivr.com/package/npm/katex) | ||
|  | ||
|
|
||
| KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web. | ||
|
|
||
|
|
@@ -10,126 +13,73 @@ KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the we | |
| * **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. More information can be found on the [list of supported commands](https://khan.github.io/KaTeX/function-support.html) and on the [wiki](https://github.com/khan/katex/wiki). | ||
| KaTeX is compatible with all major browsers, including Chrome, Safari, Firefox, Opera, Edge, and IE 9–11. | ||
|
|
||
| ## Usage | ||
| KaTeX supports much (but not all) of LaTeX and many LaTeX packages. See the [list of supported functions](https://katex.org/docs/supported.html). | ||
|
|
||
| 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: | ||
| Try out KaTeX [on the demo page](https://katex.org/#demo)! | ||
|
|
||
| ```html | ||
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0-beta1/katex.min.css" integrity="sha384-VEnyslhHLHiYPca9KFkBB3CMeslnM9CzwjxsEbZTeA21JBm7tdLwKoZmCt3cZTYD" crossorigin="anonymous"> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0-beta1/katex.min.js" integrity="sha384-O4hpKqcplNCe+jLuBVEXC10Rn1QEqAmX98lKAIFBEDxZI0a+6Z2w2n8AEtQbR4CD" crossorigin="anonymous"></script> | ||
| ``` | ||
|
|
||
| #### In-browser rendering | ||
| ## Getting started | ||
|
|
||
| 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); | ||
| ``` | ||
| ### Starter template | ||
|
|
||
| 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>' | ||
| ```html | ||
| <!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/[email protected]/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/[email protected]/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/[email protected]/dist/contrib/auto-render.min.js" integrity="sha384-kmZOZB5ObwgQnS/DuDg6TScgOiWWBiVt0plIRkZCmE6rDZGrEOQeHM5PcHi+nyqe" crossorigin="anonymous" | ||
| onload="renderMathInElement(document.body);"></script> | ||
| </head> | ||
| ... | ||
| </html> | ||
| ``` | ||
|
|
||
| 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. | ||
|
|
||
| #### Security | ||
|
|
||
| Any HTML generated by KaTeX *should* be safe from `<script>` or other code | ||
| injection attacks. | ||
| (See `maxSize` below for preventing large width/height visual affronts.) | ||
| Of course, it is always a good idea to sanitize the HTML, though you will need | ||
| a rather generous whitelist (including some of SVG and MathML) to support | ||
| all of KaTeX. | ||
|
|
||
| #### Handling errors | ||
|
|
||
| If KaTeX encounters an error (invalid or unsupported LaTeX), then it will | ||
| throw an exception of type `katex.ParseError`. The message in this error | ||
| includes some of the LaTeX source code, so needs to be escaped if you want | ||
| to render it to HTML. In particular, you should convert `&`, `<`, `>` | ||
| characters to `&`, `<`, `>` (e.g., using `_.escape`) | ||
| before including either LaTeX source code or exception messages in your | ||
| HTML/DOM. (Failure to escape in this way makes a `<script>` injection | ||
| attack possible if your LaTeX source is untrusted.) | ||
|
|
||
| #### Rendering options | ||
| You can also [download KaTeX](https://github.com/khan/katex/releases) and host it yourself. | ||
|
|
||
| You can provide an object of options as the last argument to `katex.render` and `katex.renderToString`. Available options are: | ||
| For details on how to configure auto-render extension, refer to [the documentation](https://katex.org/docs/autorender.html). | ||
|
|
||
| - `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. Single-character keys can also be included in which case the character will be redefined as the given macro (similar to TeX active characters). | ||
| - `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}`). | ||
| - `maxSize`: `number`. If non-zero, all user-specified sizes, e.g. in `\rule{500em}{500em}`, will be capped to `maxSize` ems. Otherwise, users can make elements and spaces arbitrarily large (the default behavior). | ||
| ### API | ||
|
|
||
| Call `katex.render` to render a TeX expression directly into a DOM element. | ||
| For example: | ||
|
|
||
| ```js | ||
| katex.render("c = \\pm\\sqrt{a^2 + b^2}\\in\\RR", element, { | ||
| displayMode: true, | ||
| macros: { | ||
| "\\RR": "\\mathbb{R}" | ||
| } | ||
| katex.render("c = \\pm\\sqrt{a^2 + b^2}", element, { | ||
| throwOnError: false | ||
| }); | ||
| ``` | ||
|
|
||
| #### Automatic rendering of math on a page | ||
| Call `katex.renderToString` to generate an HTML string of the rendered math, | ||
| e.g., for server-side rendering. For example: | ||
|
|
||
| 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. | ||
| ```js | ||
| var html = katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}", { | ||
| throwOnError: false | ||
| }); | ||
| // '<span class="katex">...</span>' | ||
| ``` | ||
|
|
||
| #### Font size and lengths | ||
| 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. | ||
|
|
||
| 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: | ||
| 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](https://katex.org/docs/api.html), | ||
| [options documentation](https://katex.org/docs/options.html), and | ||
| [handling errors documentation](https://katex.org/docs/error.html). | ||
|
|
||
| ```css | ||
| .katex { font-size: 1.1em; } | ||
| ``` | ||
| ## Demo and Documentation | ||
|
|
||
| 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. | ||
|
|
||
| ### Common Issues | ||
| - Many Markdown preprocessors, such as the one that Jekyll and GitHub Pages use, | ||
| have a "smart quotes" feature. This changes `'` to `’` which is an issue for | ||
| math containing primes, e.g. `f'`. This can be worked around by defining a | ||
| single character macro which changes them back, e.g. `{"’", "'"}`. | ||
| - KaTeX follows LaTeX's rendering of `aligned` and `matrix` environments unlike | ||
| MathJax. When displaying fractions one above another in these vertical | ||
| layouts there may not be enough space between rows for people who are used to | ||
| MathJax's rendering. The distance between rows can be adjusted by using | ||
| `\\[0.1em]` instead of the standard line separator distance. | ||
| - KaTeX does not support the `align` environment because LaTeX doesn't support | ||
| `align` in math mode. The `aligned` environment offers the same functionality | ||
| but in math mode, so use that instead or define a macro that maps `align` to | ||
| `aligned`. | ||
|
|
||
| ## Libraries | ||
|
|
||
| ### Angular2+ | ||
| - [ng-katex](https://github.com/garciparedes/ng-katex) Angular module to write beautiful math expressions with TeX syntax boosted by KaTeX library | ||
|
|
||
| ### Ruby | ||
|
|
||
| - [katex-ruby](https://github.com/glebm/katex-ruby) Provides server-side rendering and integration with popular Ruby web frameworks (Rails, Hanami, and anything that uses Sprockets). | ||
| Learn more about using KaTeX [on the website](https://katex.org)! | ||
|
|
||
| ## Contributing | ||
|
|
||
|
|
||
Oops, something went wrong.