diff --git a/docs/supported.md b/docs/supported.md index 2c7e0e45..991a6002 100644 --- a/docs/supported.md +++ b/docs/supported.md @@ -84,26 +84,33 @@ $( \big( \Big( \bigg( \Bigg($ `( \big( \Big( \bigg( \Bigg(` |$\begin{vmatrix} a & b \\ c & d \end{vmatrix}$ |`\begin{vmatrix}`
   `a & b \\`
   `c & d`
`\end{vmatrix}` |$\begin{Vmatrix} a & b \\ c & d \end{Vmatrix}$ |`\begin{Vmatrix}`
   `a & b \\`
   `c & d`
`\end{Vmatrix}` |$\begin{Bmatrix} a & b \\ c & d \end{Bmatrix}$ |`\begin{Bmatrix}`
   `a & b \\`
   `c & d`
`\end{Bmatrix}`|$\def\arraystretch{1.5}\begin{array}{c:c:c} a & b & c \\ \hline d & e & f \\ \hdashline g & h & i \end{array}$|`\def\arraystretch{1.5}`
   `\begin{array}{c:c:c}`
   `a & b & c \\ \hline`
   `d & e & f \\`
   `\hdashline`
   `g & h & i`
`\end{array}` |$x = \begin{cases} a &\text{if } b \\ c &\text{if } d \end{cases}$ |`x = \begin{cases}`
   `a &\text{if } b \\`
   `c &\text{if } d`
`\end{cases}`|$\begin{rcases} a &\text{if } b \\ c &\text{if } d \end{rcases}⇒…$ |`\begin{rcases}`
   `a &\text{if } b \\`
   `c &\text{if } d`
`\end{rcases}⇒…`| -|$\begin{smallmatrix} a & b \\ c & d \end{smallmatrix}$ | `\begin{smallmatrix}`
   `a & b \\`
   `c & d`
`\end{smallmatrix}` |$$\begin{CD}A @>a>> B \\@VbVV @AAcA\\C @= D\end{CD}$$ |`\begin{CD}`
   `A @>a>> B \\`
`@VbVV @AAcA \\`
   `C @= D`
`\\end{CD}`| +|$\begin{smallmatrix} a & b \\ c & d \end{smallmatrix}$ | `\begin{smallmatrix}`
   `a & b \\`
   `c & d`
`\end{smallmatrix}` |$$\sum_{\begin{subarray}{l} i\in\Lambda\\  0`\begin{subarray}{l}`
   `i\in\Lambda\\`
   `0`\end{subarray}}`| + +The auto-render extension will render the following environments even if they are not inside math delimiters such as `$$…$$`. They are display-mode only. + + +
||||| -|:---------------------|:---------------------| -|$$\begin{align} a&=b+c \\ d+e&=f \end{align}$$ |`\begin{align}`
   `a&=b+c \\`
   `d+e&=f`
`\end{align}` -|$$\begin{alignat}{2}10&x+&3&y=2\\3&x+&13&y=4\end{alignat}$$ |`\begin{alignedat}{2}`
   `10&x+ &3&y = 2 \\`
   ` 3&x+&13&y = 4`
`\end{alignedat}` -|`\begin{equation}`
`\begin{split}`   `a &=b+c\\`
      `&=e+f`
`\end{split}`
`\end{equation}` -|$$\begin{gather} a=b \\ e=b+c \end{gather}$$ |`\begin{gather}`
   `a=b \\ `
   `e=b+c`
`\end{gather}` +|:---------------------|:---------------------|:---------------------|:-------- +|$$\begin{equation}\begin{split}a &=b+c\\&=e+f\end{split}\end{equation}$$ |`\begin{equation}`
`\begin{split}`   `a &=b+c\\`
      `&=e+f`
`\end{split}`
`\end{equation}` |$$\begin{align} a&=b+c \\ d+e&=f \end{align}$$ |`\begin{align}`
   `a&=b+c \\`
   `d+e&=f`
`\end{align}` | +|$$\begin{gather} a=b \\ e=b+c \end{gather}$$ |`\begin{gather}`
   `a=b \\ `
   `e=b+c`
`\end{gather}`|$$\begin{alignat}{2}10&x+&3&y=2\\3&x+&13&y=4\end{alignat}$$ | `\begin{alignat}{2}`
   `10&x+&3&y=2\\`
   `3&x+&13&y=4`
`\end{alignat}` +|$$\begin{CD}A @>a>> B \\@VbVV @AAcA\\C @= D\end{CD}$$ |`\begin{CD}`
   `A @>a>> B \\`
`@VbVV @AAcA \\`
   `C @= D`
`\\end{CD}` + +#### Other KaTeX Environments + +| Environments | How they differ from those shown above | +|:-----------------------------------------------|:------------------| +| `darray`, `dcases`, `drcases` | … apply `displaystyle` | +| `matrix*`, `pmatrix*`, `bmatrix*`
`Bmatrix*`, `vmatrix*`, `Vmatrix*` | … take an optional argument to set column
alignment, as in `\begin{matrix*}[r]` +| `equation*`, `gather*`
`align*`, `alignat*` | … have no automatic numbering. | +| `gathered`, `aligned`, `alignedat` | … do not need to be in display mode.
… have no automatic numbering.
… must be inside math delimiters in
order to be rendered by the auto-render
extension. | -KaTeX also supports: -* `darray`, `dcases`, and `drcases`, which render in `displaystyle` -* `align*`, `alignat*`, `gather*`, and `equation*`, which omit equation numbers -* `aligned`, `alignedat`, and `gathered`, which LaTeX will render while in math mode - -Environments `align`, `alignat`, `CD`, `equation`, and `gather` (and their starred versions) may be called from display mode. This usually means that they may be called from within `$$…$$` delimiters or `\[…\]` delimiters. They may not be called from within `$…$` or `\(…\)` delimiters. In the KaTeX auto-render extension, as in LaTeX, these environments are themselves are a way to change from text mode to math display mode, and `\[…\]` delimiters are not necessary. - -And KaTeX supports `matrix*`, `pmatrix*`, `bmatrix*`, `Bmatrix*`, `vmatrix*`, and `Vmatrix*`, which take an optional argument to set column alignment, as in `\begin{matrix}[1]`, `\begin{matrix}[c]`, or `\begin{matrix}[r]`. - Acceptable line separators include: `\\`, `\cr`, `\\[distance]`, and `\cr[distance]`. *Distance* can be written with any of the [KaTeX units](#units). The `{array}` environment supports `|` and `:` vertical separators.