From d470cc0b3f998a0fc3ef28394d08940498d3e848 Mon Sep 17 00:00:00 2001 From: Kevin Barabash Date: Wed, 27 Dec 2017 09:51:20 -0700 Subject: [PATCH] Add a 'common issues' section to the README (#1034) --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 20054596..f98c991e 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,21 @@ 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+