Add a 'common issues' section to the README #1034
Conversation
README.md
Outdated
| standard line separator. | ||
| - KaTeX does not support the `align` environment because LaTeX doesn't support | ||
| `align` in math mode. You can define a macro that maps `align` to `aligned` | ||
| to work aroudn this. |
There was a problem hiding this comment.
Typo "aroudn". Also some readers may not be familiar with aligned (partly because it's amsmath, not regular LaTeX -- at least I didn't know about it until I learned KaTeX), so maybe a short introduction of "aligned offers the same functionality but in math mode, so use that instead" before mentioning macro option?
README.md
Outdated
| 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. When |
There was a problem hiding this comment.
Extra * before "matrix". Should we add "unlike MathJax" here?
There was a problem hiding this comment.
I'm going to put *matrix inside backticks to get around the italics issues.
There was a problem hiding this comment.
What is *matrix? Maybe it's matrix*? (I'm just guessing based on LaTeX conventions.) Does this comment not apply to regular matrix? Also I'd suggest adding backticks to aligned to match.
There was a problem hiding this comment.
Doesn't *matrix cover matrix, bmatrix, pmatrix, etc.? I guess in this case * is overloaded... I can just write all matrix environments.
There was a problem hiding this comment.
I'm going to leave the all out.
|
Small nit: The distance between rows can be adjusted by using... |
Addressed #967, replaces #1020.