From e73f3a6b282ddac55e7549d9d148bd9910871f75 Mon Sep 17 00:00:00 2001 From: Eric Wieser Date: Fri, 3 Mar 2023 19:53:40 +0000 Subject: [PATCH] Add a test using a markdownit renderer --- latex.html | 608 ++++++++++++++++++++++++++++++++++++++++ markdown_it_renderer.py | 0 templates/base.j2 | 25 +- test/latex.html | 584 ++++++++++++++++++++++++++++++++++++++ test/test_latex.py | 34 +++ 5 files changed, 1249 insertions(+), 2 deletions(-) create mode 100644 latex.html create mode 100644 markdown_it_renderer.py create mode 100644 test/latex.html create mode 100644 test/test_latex.py diff --git a/latex.html b/latex.html new file mode 100644 index 0000000..8ecfc5a --- /dev/null +++ b/latex.html @@ -0,0 +1,608 @@ + + + + + + + + LaTeX test - mathlib docs + + + + + + + + + + + + + + + + + + +
+

mathlib + documentation

+

LaTeX test

+
+ + + +
+
+ + + +
+ + +

LaTeX examples

+

This test page collects several examples of LaTeX in markdown.

+

Compare: https://math.meta.stackexchange.com/revisions/9386/164

+

Examples from doc-gen issues

+

From doc-gen#10, what if I put f[*a,*b](cd) in tex? g_{x_0}(y) ?

+

From doc-gen#62:

+ +

Example from dynamics.circle.rotation_number.translation_number:

+

For any x : ℝ the sequence \frac{f^n(x)-x}{n} tends to the translation number of f.
+In particular, this limit does not depend on x.

+

mathlib#3776

+

Before PR (has a stray cc), line spacing too large:

+
+J = \left[\begin{align}{cc} + 0_l & 1_l\\\\ + 1_l & 0_l + \end{align}\right] +
+

After PR, line spacing too large:

+
+J = \left[\begin{array}{cc} + 0_l & 1_l\\\\ + 1_l & 0_l + \end{array}\right] +
+

Actually fixed:

+
+J = \left[\begin{array}{cc} + 0_l & 1_l\\ + 1_l & 0_l + \end{array}\right] +
+

mathlib#6175

+

Before PR (renders correctly):

+

If a function is analytic in a disk D(x, R), then it is analytic in any disk contained in that
+one. Indeed, one can write
+$f (x + y + z) = \sum_{n} p_n (y + z)^n = \sum_{n, k} \binom{n}{k} p_n y^{n-k} z^k += \sum_{k} \Bigl(\sum_{n} \binom{n}{k} p_n y^{n-k}\Bigr) z^k.The corresponding power series has thus a `k`-th coefficient equal to\sum_{n} \binom{n}{k} p_n y^{n-k}$. In the general case where pₙ is a multilinear map, this has
+to be interpreted suitably: instead of having a binomial coefficient, one should sum over all
+possible subsets s of fin n of cardinal k, and attribute z to the indices in s and
+y to the indices outside of s.
+In this paragraph, we implement this. The new power series is called p.change_origin y. Then, we
+check its convergence and the fact that its sum coincides with the original sum. The outcome of this
+discussion is that the set of points where a function is analytic is open.

+

After PR (with two backslashes before sum as a workaround; should be broken):

+

If a function is analytic in a disk D(x, R), then it is analytic in any disk contained in that
+one. Indeed, one can write
+$f (x + y + z) = \\sum_{n} p_n (y + z)^n = \\sum_{n, k} \binom{n}{k} p_n y^{n-k} z^k += \\sum_{k} \Bigl(\\sum_{n} \binom{n}{k} p_n y^{n-k}\Bigr) z^k.The corresponding power series has thus a `k`-th coefficient equal to\sum_{n} \binom{n}{k} p_n y^{n-k}$. In the general case where pₙ is a multilinear map, this has
+to be interpreted suitably: instead of having a binomial coefficient, one should sum over all
+possible subsets s of fin n of cardinal k, and attribute z to the indices in s and
+y to the indices outside of s.

+

Line spacing tests

+

(math.stackexchange.com results given above each example)

+
+

Renders OK ✅:
+\alpha +\alpha

+
+

Should not render ❌:
+$\alpha

+

\alpha$

+
+

Should not render ❌:
+$$\alpha

+

\alpha$$

+
+

Should not render ❌:
+$$

+

\alpha
+\alpha

+
+--- + +Renders OK ✅: +$$ \alpha\alpha +
+
+

Renders OK ✅:
+$\alpha\alpha +[hi](345) +b$

+
+

Should not render ❌:
+$$ \alpha\alpha hi \beta

+
+--- + +Renders OK ✅: +\begin{align} +\begin{matrix} +a & b & c +\end{matrix} +\end{align} + +--- + +Only the inner matrix environment should render: +\begin{align} + +[hi](https://github.com) +\begin{matrix} +a & b & c +\end{matrix} +\end{align} + +--- + +Should not render ❌: +\begin{align} + +\begin{matrix} + +a & b & c +\end{matrix} +\end{align} + +--- + +Renders OK ✅: + +hi there \begin{align} 3 \\ 3 \end{align} + +--- + +Should not render ❌: +\begin{align} +\end{blah} + +--- + +Should not render ❌: +\begin{align} +[link](https://github.com) { {\alpha} +\end{align} + +## Nested environments + +From <http://web.archive.org/web/20120617014306/http://www.st.fmph.uniba.sk/~kiselak1/pdfka/tex/latexMath_align.pdf> + +\begin{align}T(n) & \leq 2(c\lfloor n/2 \rfloor \lg( \lfloor n/2 \rfloor )) + n \\T(n) & \leq 2(cn/2) \lg(n/2) + n \\T(n) & = cn (\lg n - 1) + n \\T(n) & \leq cn \lg n\end{align} + +\begin{align} +T(n) & \leq 2(c\lfloor n/2 \rfloor \lg( \lfloor n/2 \rfloor )) + n \\ +T(n) & \leq 2(cn/2) \lg(n/2) + n \\ +T(n) & = cn (\lg n - 1) + n \\ +T(n) & \leq cn \lg n +\end{align} + +\begin{gather} +\begin{aligned}T(n) & \leq 2(c\lfloor n/2 \rfloor \lg( \lfloor n/2 \rfloor )) + n \\T(n) & \leq 2(cn/2) \lg(n/2) + n \\T(n) & = cn (\lg n - 1) + n \\T(n) & \leq cn \lg n\end{aligned}\end{gather} + +\begin{gather} +\begin{aligned} +T(n) & \leq 2(c\lfloor n/2 \rfloor \lg( \lfloor n/2 \rfloor )) + n \\ +T(n) & \leq 2(cn/2) \lg(n/2) + n \\ +T(n) & = cn (\lg n - 1) + n \\ +T(n) & \leq cn \lg n +\end{aligned} +\end{gather} + +\begin{align}\begin{aligned}T(n) & \leq 2(c\lfloor n/2 \rfloor \lg( \lfloor n/2 \rfloor )) + n \\T(n) & \leq 2(cn/2) \lg(n/2) + n \\T(n) & = cn (\lg n - 1) + n \\T(n) & \leq cn \lg n\end{aligned}\end{align} + + +## MathJax basic tutorial and quick reference + +From <https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference> + +(Deutsch: [MathJax: LaTeX Basic Tutorial und Referenz](https://www.mathelounge.de/509545/mathjax-latex-basic-tutorial-und-referenz-deutsch)) + +1. To see how any formula was written in any question or answer, including this one, right-click on the expression it and choose "Show Math As > TeX Commands". (When you do this, the '$' will not display. Make sure you add these. See the next point. There are also [other possibilities](https://math.meta.stackexchange.com/q/659) how to view the code for the formula or the whole post.) + +2. **For inline formulas, enclose the formula in `$...$`. For displayed formulas, use `$$...$$`.** +These render differently. For example, +type +`$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$` +to show $\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$ (which is inline mode) or type +`$$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$$` +to show +$$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6} +
+

(which is display mode).

+
    +
  1. +

    For Greek letters, use \alpha, \beta, …, \omega: \alpha, \beta, … \omega. For uppercase, use \Gamma, \Delta, …, \Omega: \Gamma, \Delta, …, \Omega. Some Greek letters have variant forms:
    +\epsilon \varepsilon \epsilon, \varepsilon, \phi \varphi \phi, \varphi, and others.

    +
    2. +
  2. +

    For superscripts and subscripts, use ^ and _. For example, x_i^2: x_i^2, \log_2 x: \log_2 x.

    +
    3. +
  3. +

    Groups. Superscripts, subscripts, and other operations apply only to the next “group”. A “group” is either a single symbol, or any formula surrounded by curly braces {…}. If you do 10^10, you will get a surprise: 10^10. But 10^{10} gives what you probably wanted: 10^{10}. Use curly braces to delimit a formula to which a superscript or subscript applies: x^5^6 is an error; {x^y}^z is {x^y}^z, and x^{y^z} is x^{y^z}. Observe the difference between x_i^2 x_i^2 and x_{i^2} x_{i^2}.

    +
    4. +
  4. +

    Parentheses Ordinary symbols ()[] make parentheses and brackets (2+3)[4+4]. Use \{ and \} for curly braces \{\}.

    +

    These do not scale with the formula in between, so if you write (\frac{\sqrt x}{y^3}) the parentheses will be too small: (\frac{\sqrt x}{y^3}). Using \left(…\right) will make the sizes adjust automatically to the formula they enclose: \left(\frac{\sqrt x}{y^3}\right) is \left(\frac{\sqrt x}{y^3}\right).

    +

    \left and\right apply to all the following sorts of parentheses: ( and ) (x), [ and ] [x], \{ and \} \{ x \}, | |x|, \vert \vert x \vert, \Vert \Vert x \Vert, \langle and \rangle \langle x \rangle, \lceil and \rceil \lceil x \rceil, and \lfloor and \rfloor \lfloor x \rfloor. \middle can be used to add additional dividers. There are also invisible parentheses, denoted by .: \left.\frac12\right\rbrace is \left.\frac12\right\rbrace.

    +

    If manual size adjustments are required:
    +\Biggl(\biggl(\Bigl(\bigl((x)\bigr)\Bigr)\biggr)\Biggr) gives
    +\Biggl(\biggl(\Bigl(\bigl((x)\bigr)\Bigr)\biggr)\Biggr).

    +
    5. +
  5. +

    Sums and integrals \sum and \int; the subscript is the lower limit and the superscript is the upper limit, so for example \sum_1^n \sum_1^n. Don't forget {…} if the limits are more than a single symbol. For example, \sum_{i=0}^\infty i^2 is \sum_{i=0}^\infty i^2. Similarly, \prod \prod, \int \int, \bigcup \bigcup, \bigcap \bigcap, \iint \iint, \iiint \iiint, \idotsint \idotsint.

    +
    6. +
  6. +

    Fractions There are three ways to make these. \frac ab applies to the next two groups, and produces \frac ab; for more complicated numerators and denominators use {…}: \frac{a+1}{b+1} is \frac{a+1}{b+1}. If the numerator and denominator are complicated, you may prefer \over, which splits up the group that it is in: {a+1\over b+1} is {a+1\over b+1}.
    +Using \cfrac{a}{b} command is useful for continued fractions \cfrac{a}{b}, more details for which are given in this sub-article.

    +
    7. +
  7. +

    Fonts

    +
    8. +
+ +
    +
  1. +

    Radical signs / roots Use sqrt, which adjusts to the size of its argument: \sqrt{x^3} \sqrt{x^3}; \sqrt[3]{\frac xy} \sqrt[3]{\frac xy}. For complicated expressions, consider using {...}^{1/2} instead.

    +
    2. +
  2. +

    Some special functions such as "lim", "sin", "max", "ln", and so on are normally set in roman font instead of italic font. Use \lim, \sin, etc. to make these: \sin x \sin x, not sin x sin x. Use subscripts to attach a notation to \lim: \lim_{x\to 0} $\lim_{x\to 0}Nonstandard function names can be set with `\operatorname{foo}(x)`\operatorname{foo}(x)$.

    +
    3. +
  3. +

    There are a very large number of special symbols and notations, too many to list here; see this shorter listing, or this exhaustive listing. Some of the most common include:

    +
    4. +
+ +

Detexify lets you draw a symbol on a web page and then lists the \TeX symbols that seem to resemble it. These are not guaranteed to work in MathJax but are a good place to start. To check that a command is supported, note that MathJax.org maintains a list of currently supported \LaTeX commands, and one can also check Dr. Carol JVF Burns's page of \TeX Commands Available in MathJax.

+
    +
  1. Spaces MathJax usually decides for itself how to space formulas, using a complex set of rules. Putting extra literal spaces into formulas will not change the amount of space MathJax puts in: a␣b and a␣␣␣␣b are both a b. To add more space, use \, for a thin space a\,b; \; for a wider space a\;b. \quad and \qquad are large spaces: a\quad b, a\qquad b.
    2. +
+

To set plain text, use \text{…}: \{x\in s\mid x\text{ is extra large}\}. You can nest $…$ inside of \text{…}, for example to access spaces.

+
    +
  1. +

    Accents and diacritical marks Use \hat for a single symbol \hat x, \widehat for a larger formula \widehat{xy}. If you make it too wide, it will look silly. Similarly, there are \bar \bar x and \overline \overline{xyz}, and \vec \vec x and \overrightarrow \overrightarrow{xy} and \overleftrightarrow \overleftrightarrow{xy}. For dots, as in \frac d{dx}x\dot x = \dot x^2 + x\ddot x, use \dot and \ddot.

    +
    2. +
  2. +

    Special characters used for MathJax interpreting can be escaped using the \ character: \$ \$, \{ \{, \_ \_, etc. If you want \ itself, you should use \backslash (symbol) or \setminus (binary operation) for \backslash, because \\ is for a new line.

    +
    3. +
+

(Tutorial ends here.)

+
+

It is important that this note be reasonably short and not suffer from too much bloat. To include more topics, please create short addenda and post them as answers instead of inserting them into this post.

+

Contents

+

Alphabetical list of links to To MathJax Topics, by title:

+ +

Aligned equations

+

https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference/5024#5024

+

Often people want a series of equations where the equals signs are aligned. To get this, use \begin{align}…\end{align}. Each line should end with \\, and should contain an ampersand at the point to align at, typically immediately before the equals sign.

+

For example,

+

\begin{align}
+\sqrt{37} & = \sqrt{\frac{73^2-1}{12^2}} \
+& = \sqrt{\frac{73^2}{12^2}\cdot\frac{73^2-1}{73^2}} \
+& = \sqrt{\frac{73^2}{12^2}}\sqrt{\frac{73^2-1}{73^2}} \
+& = \frac{73}{12}\sqrt{1 - \frac{1}{73^2}} \
+& \approx \frac{73}{12}\left(1 - \frac{1}{2\cdot73^2}\right)
+\end{align}

+

is produced by

+
\begin{align}
+
+

\sqrt{37} & = \sqrt{\frac{73^2-1}{12^2}} \
+& = \sqrt{\frac{73^2}{12^2}\cdot\frac{73^2-1}{73^2}} \
+& = \sqrt{\frac{73^2}{12^2}}\sqrt{\frac{73^2-1}{73^2}} \
+& = \frac{73}{12}\sqrt{1 - \frac{1}{73^2}} \
+& \approx \frac{73}{12}\left(1 - \frac{1}{2\cdot73^2}\right)
+\end{align}

+

The usual $$ marks that delimit the display may be omitted here.

+

Definitions by cases (piecewise functions)

+

https://math.meta.stackexchange.com/a/5025

+

Use \begin{cases}…\end{cases}. End each case with a \\, and use & before parts that should be aligned.

+

For example, you get this:

+
+f(n) = +\begin{cases} +n/2, & \text{if $n$ is even} \\ +3n+1, & \text{if $n$ is odd} +\end{cases} +
+

by writing this:

+
  f(n) =
+\begin{cases}
+
+

n/2, & \text{if n is even} \
+3n+1, & \text{if n is odd}
+\end{cases}

+

The brace can be moved to the right:
+$\left. +\begin{array}{l} +\text{ifnis even:}&n/2\\ +\text{ifnis odd:}&3n+1 +\end{array} +\right\} +=f(n)$
+by writing this:

+
\left.
+\begin{array}{l}
+
+

\text{if n is even:}&n/2\
+\text{if n is odd:}&3n+1
+\end{array}
+\right}
+=f(n)

+

To get a larger vertical space between cases we can use \\[2ex] instead of \\. For example, you get this:

+
+f(n) = +\begin{cases} +\frac{n}{2}, & \text{if $n$ is even} \\[2ex] +3n+1, & \text{if $n$ is odd} +\end{cases} +
+

by writing this:

+
f(n) =
+\begin{cases}
+
+

\frac{n}{2}, & \text{if n is even} \[2ex]
+3n+1, & \text{if n is odd}
+\end{cases}

+

(An ‘ex’ is a length equal to the height of the letter x; 2ex here means the space should be two exes high.)

+

Matrices

+

https://math.meta.stackexchange.com/a/5023/

+
    +
  1. +

    Use $$\begin{matrix}…\end{matrix}$$ In between the \begin and \end, put the matrix elements. End each matrix row with \\, and separate matrix elements with &. For example,

    +
     $$
+ \begin{matrix}
+ 1 & x & x^2 \\
+ 1 & y & y^2 \\
+ 1 & z & z^2 \\
+ \end{matrix}
+
    +
    2. +
+
+produces: +
+
    \begin{matrix}
+    1 & x & x^2 \\
+    1 & y & y^2 \\
+    1 & z & z^2 \\
+    \end{matrix}
+
+
+MathJax will adjust the sizes of the rows and columns so that everything fits. + +2. To add brackets, either use `\left…\right` as in section 6 of the tutorial, or replace `matrix` with `pmatrix` $\begin{pmatrix}1&2\\3&4\\ \end{pmatrix}$, `bmatrix` $\begin{bmatrix}1&2\\3&4\\ \end{bmatrix}$, `Bmatrix` $\begin{Bmatrix}1&2\\3&4\\ \end{Bmatrix}$, `vmatrix` $\begin{vmatrix}1&2\\3&4\\ \end{vmatrix}$, `Vmatrix` $\begin{Vmatrix}1&2\\3&4\\ \end{Vmatrix}$. + +3. Use `\cdots` $\cdots$ `\ddots` $\ddots$ `vdots` $\vdots$ when you want to omit some of the entries: + + $$\begin{pmatrix} + 1 & a_1 & a_1^2 & \cdots & a_1^n \\ + 1 & a_2 & a_2^2 & \cdots & a_2^n \\ + \vdots & \vdots& \vdots & \ddots & \vdots \\ + 1 & a_m & a_m^2 & \cdots & a_m^n + \end{pmatrix} +
+
    +
  1. For horizontally "augmented" matrices, put parentheses or brackets around a suitably-formatted table; see arrays below for details. Here is an example:
    2. +
+
+\left[\begin{array}{cc|c} + 1&2&3\\ + 4&5&6 + \end{array}\right] +
+

is produced by:

+
    $$ \left[
+\begin{array}{cc|c}
+  1&2&3\\
+  4&5&6
+\end{array}
+
+

\right] $$

+

The cc|c is the crucial part here; it says that there are three centered columns with a vertical bar between the second and third.

+
    +
  1. For vertically "augmented" matrices, use \hline. For example
    2. +
+
+\begin{pmatrix} +a & b \\ +c & d\\ +\hline +1 & 0\\ +0 & 1 +\end{pmatrix} +
+

is produced by

+
$$
+  \begin{pmatrix}
+    a & b\\
+    c & d\\
+  \hline
+    1 & 0\\
+    0 & 1
+  \end{pmatrix}
+$$
+
+
    +
  1. +

    For small inline matrices use \bigl(\begin{smallmatrix} ... \end{smallmatrix}\bigr), e.g. \bigl( \begin{smallmatrix} a & b \\ c & d \end{smallmatrix} \bigr) is produced by:

    +
      $\bigl( \begin{smallmatrix} a & b \\ c & d \end{smallmatrix} \bigr)$
+
    +
    2. +
+

From tactic_writing.md

+ + + +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/markdown_it_renderer.py b/markdown_it_renderer.py new file mode 100644 index 0000000..e69de29 diff --git a/templates/base.j2 b/templates/base.j2 index 1559b7f..d322cb4 100644 --- a/templates/base.j2 +++ b/templates/base.j2 @@ -57,8 +57,11 @@ StackOverflow link on why to avoid \(..\) and \[..\] when markdown is in the loo + + + + + + +
+

mathlib + documentation

+

LaTeX test

+
+ + + +
+
+ + + +
+ + +

LaTeX examples

+

This test page collects several examples of LaTeX in markdown.

+

Compare: https://math.meta.stackexchange.com/revisions/9386/164

+

Examples from doc-gen issues

+

From doc-gen#10, what if I put f[*a,*b](cd) in tex? g_{x_0}(y) ?

+

From doc-gen#62:

+ +

Example from dynamics.circle.rotation_number.translation_number:

+

For any x : ℝ the sequence \frac{f^n(x)-x}{n} tends to the translation number of f.
+In particular, this limit does not depend on x.

+

mathlib#3776

+

Before PR (has a stray cc), line spacing too large:

+
+J = \left[\begin{align}{cc} + 0_l & 1_l\\\\ + 1_l & 0_l + \end{align}\right] +
+

After PR, line spacing too large:

+
+J = \left[\begin{array}{cc} + 0_l & 1_l\\\\ + 1_l & 0_l + \end{array}\right] +
+

Actually fixed:

+
+J = \left[\begin{array}{cc} + 0_l & 1_l\\ + 1_l & 0_l + \end{array}\right] +
+

mathlib#6175

+

Before PR (renders correctly):

+

If a function is analytic in a disk D(x, R), then it is analytic in any disk contained in that
+one. Indeed, one can write
+$f (x + y + z) = \sum_{n} p_n (y + z)^n = \sum_{n, k} \binom{n}{k} p_n y^{n-k} z^k += \sum_{k} \Bigl(\sum_{n} \binom{n}{k} p_n y^{n-k}\Bigr) z^k.The corresponding power series has thus a `k`-th coefficient equal to\sum_{n} \binom{n}{k} p_n y^{n-k}$. In the general case where pₙ is a multilinear map, this has
+to be interpreted suitably: instead of having a binomial coefficient, one should sum over all
+possible subsets s of fin n of cardinal k, and attribute z to the indices in s and
+y to the indices outside of s.
+In this paragraph, we implement this. The new power series is called p.change_origin y. Then, we
+check its convergence and the fact that its sum coincides with the original sum. The outcome of this
+discussion is that the set of points where a function is analytic is open.

+

After PR (with two backslashes before sum as a workaround; should be broken):

+

If a function is analytic in a disk D(x, R), then it is analytic in any disk contained in that
+one. Indeed, one can write
+$f (x + y + z) = \\sum_{n} p_n (y + z)^n = \\sum_{n, k} \binom{n}{k} p_n y^{n-k} z^k += \\sum_{k} \Bigl(\\sum_{n} \binom{n}{k} p_n y^{n-k}\Bigr) z^k.The corresponding power series has thus a `k`-th coefficient equal to\sum_{n} \binom{n}{k} p_n y^{n-k}$. In the general case where pₙ is a multilinear map, this has
+to be interpreted suitably: instead of having a binomial coefficient, one should sum over all
+possible subsets s of fin n of cardinal k, and attribute z to the indices in s and
+y to the indices outside of s.

+

Line spacing tests

+

(math.stackexchange.com results given above each example)

+
+

Renders OK ✅:
+\alpha +\alpha

+
+

Should not render ❌:
+$\alpha

+

\alpha$

+
+

Should not render ❌:
+$$\alpha

+

\alpha$$

+
+

Should not render ❌:
+$$

+

\alpha
+\alpha

+
+--- + +Renders OK ✅: +$$ \alpha\alpha +
+
+

Renders OK ✅:
+$\alpha\alpha +[hi](345) +b$

+
+

Should not render ❌:
+$$ \alpha\alpha hi \beta

+
+--- + +Renders OK ✅: +\begin{align} +\begin{matrix} +a & b & c +\end{matrix} +\end{align} + +--- + +Only the inner matrix environment should render: +\begin{align} + +[hi](https://github.com) +\begin{matrix} +a & b & c +\end{matrix} +\end{align} + +--- + +Should not render ❌: +\begin{align} + +\begin{matrix} + +a & b & c +\end{matrix} +\end{align} + +--- + +Renders OK ✅: + +hi there \begin{align} 3 \\ 3 \end{align} + +--- + +Should not render ❌: +\begin{align} +\end{blah} + +--- + +Should not render ❌: +\begin{align} +[link](https://github.com) { {\alpha} +\end{align} + +## Nested environments + +From <http://web.archive.org/web/20120617014306/http://www.st.fmph.uniba.sk/~kiselak1/pdfka/tex/latexMath_align.pdf> + +\begin{align}T(n) & \leq 2(c\lfloor n/2 \rfloor \lg( \lfloor n/2 \rfloor )) + n \\T(n) & \leq 2(cn/2) \lg(n/2) + n \\T(n) & = cn (\lg n - 1) + n \\T(n) & \leq cn \lg n\end{align} + +\begin{align} +T(n) & \leq 2(c\lfloor n/2 \rfloor \lg( \lfloor n/2 \rfloor )) + n \\ +T(n) & \leq 2(cn/2) \lg(n/2) + n \\ +T(n) & = cn (\lg n - 1) + n \\ +T(n) & \leq cn \lg n +\end{align} + +\begin{gather} +\begin{aligned}T(n) & \leq 2(c\lfloor n/2 \rfloor \lg( \lfloor n/2 \rfloor )) + n \\T(n) & \leq 2(cn/2) \lg(n/2) + n \\T(n) & = cn (\lg n - 1) + n \\T(n) & \leq cn \lg n\end{aligned}\end{gather} + +\begin{gather} +\begin{aligned} +T(n) & \leq 2(c\lfloor n/2 \rfloor \lg( \lfloor n/2 \rfloor )) + n \\ +T(n) & \leq 2(cn/2) \lg(n/2) + n \\ +T(n) & = cn (\lg n - 1) + n \\ +T(n) & \leq cn \lg n +\end{aligned} +\end{gather} + +\begin{align}\begin{aligned}T(n) & \leq 2(c\lfloor n/2 \rfloor \lg( \lfloor n/2 \rfloor )) + n \\T(n) & \leq 2(cn/2) \lg(n/2) + n \\T(n) & = cn (\lg n - 1) + n \\T(n) & \leq cn \lg n\end{aligned}\end{align} + + +## MathJax basic tutorial and quick reference + +From <https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference> + +(Deutsch: [MathJax: LaTeX Basic Tutorial und Referenz](https://www.mathelounge.de/509545/mathjax-latex-basic-tutorial-und-referenz-deutsch)) + +1. To see how any formula was written in any question or answer, including this one, right-click on the expression it and choose "Show Math As > TeX Commands". (When you do this, the '$' will not display. Make sure you add these. See the next point. There are also [other possibilities](https://math.meta.stackexchange.com/q/659) how to view the code for the formula or the whole post.) + +2. **For inline formulas, enclose the formula in `$...$`. For displayed formulas, use `$$...$$`.** +These render differently. For example, +type +`$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$` +to show $\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$ (which is inline mode) or type +`$$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$$` +to show +$$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6} +
+

(which is display mode).

+
    +
  1. +

    For Greek letters, use \alpha, \beta, …, \omega: \alpha, \beta, … \omega. For uppercase, use \Gamma, \Delta, …, \Omega: \Gamma, \Delta, …, \Omega. Some Greek letters have variant forms:
    +\epsilon \varepsilon \epsilon, \varepsilon, \phi \varphi \phi, \varphi, and others.

    +
    2. +
  2. +

    For superscripts and subscripts, use ^ and _. For example, x_i^2: x_i^2, \log_2 x: \log_2 x.

    +
    3. +
  3. +

    Groups. Superscripts, subscripts, and other operations apply only to the next “group”. A “group” is either a single symbol, or any formula surrounded by curly braces {…}. If you do 10^10, you will get a surprise: 10^10. But 10^{10} gives what you probably wanted: 10^{10}. Use curly braces to delimit a formula to which a superscript or subscript applies: x^5^6 is an error; {x^y}^z is {x^y}^z, and x^{y^z} is x^{y^z}. Observe the difference between x_i^2 x_i^2 and x_{i^2} x_{i^2}.

    +
    4. +
  4. +

    Parentheses Ordinary symbols ()[] make parentheses and brackets (2+3)[4+4]. Use \{ and \} for curly braces \{\}.

    +

    These do not scale with the formula in between, so if you write (\frac{\sqrt x}{y^3}) the parentheses will be too small: (\frac{\sqrt x}{y^3}). Using \left(…\right) will make the sizes adjust automatically to the formula they enclose: \left(\frac{\sqrt x}{y^3}\right) is \left(\frac{\sqrt x}{y^3}\right).

    +

    \left and\right apply to all the following sorts of parentheses: ( and ) (x), [ and ] [x], \{ and \} \{ x \}, | |x|, \vert \vert x \vert, \Vert \Vert x \Vert, \langle and \rangle \langle x \rangle, \lceil and \rceil \lceil x \rceil, and \lfloor and \rfloor \lfloor x \rfloor. \middle can be used to add additional dividers. There are also invisible parentheses, denoted by .: \left.\frac12\right\rbrace is \left.\frac12\right\rbrace.

    +

    If manual size adjustments are required:
    +\Biggl(\biggl(\Bigl(\bigl((x)\bigr)\Bigr)\biggr)\Biggr) gives
    +\Biggl(\biggl(\Bigl(\bigl((x)\bigr)\Bigr)\biggr)\Biggr).

    +
    5. +
  5. +

    Sums and integrals \sum and \int; the subscript is the lower limit and the superscript is the upper limit, so for example \sum_1^n \sum_1^n. Don't forget {…} if the limits are more than a single symbol. For example, \sum_{i=0}^\infty i^2 is \sum_{i=0}^\infty i^2. Similarly, \prod \prod, \int \int, \bigcup \bigcup, \bigcap \bigcap, \iint \iint, \iiint \iiint, \idotsint \idotsint.

    +
    6. +
  6. +

    Fractions There are three ways to make these. \frac ab applies to the next two groups, and produces \frac ab; for more complicated numerators and denominators use {…}: \frac{a+1}{b+1} is \frac{a+1}{b+1}. If the numerator and denominator are complicated, you may prefer \over, which splits up the group that it is in: {a+1\over b+1} is {a+1\over b+1}.
    +Using \cfrac{a}{b} command is useful for continued fractions \cfrac{a}{b}, more details for which are given in this sub-article.

    +
    7. +
  7. +

    Fonts

    +
    8. +
+ +
    +
  1. +

    Radical signs / roots Use sqrt, which adjusts to the size of its argument: \sqrt{x^3} \sqrt{x^3}; \sqrt[3]{\frac xy} \sqrt[3]{\frac xy}. For complicated expressions, consider using {...}^{1/2} instead.

    +
    2. +
  2. +

    Some special functions such as "lim", "sin", "max", "ln", and so on are normally set in roman font instead of italic font. Use \lim, \sin, etc. to make these: \sin x \sin x, not sin x sin x. Use subscripts to attach a notation to \lim: \lim_{x\to 0} $\lim_{x\to 0}Nonstandard function names can be set with `\operatorname{foo}(x)`\operatorname{foo}(x)$.

    +
    3. +
  3. +

    There are a very large number of special symbols and notations, too many to list here; see this shorter listing, or this exhaustive listing. Some of the most common include:

    +
    4. +
+ +

Detexify lets you draw a symbol on a web page and then lists the \TeX symbols that seem to resemble it. These are not guaranteed to work in MathJax but are a good place to start. To check that a command is supported, note that MathJax.org maintains a list of currently supported \LaTeX commands, and one can also check Dr. Carol JVF Burns's page of \TeX Commands Available in MathJax.

+
    +
  1. Spaces MathJax usually decides for itself how to space formulas, using a complex set of rules. Putting extra literal spaces into formulas will not change the amount of space MathJax puts in: a␣b and a␣␣␣␣b are both a b. To add more space, use \, for a thin space a\,b; \; for a wider space a\;b. \quad and \qquad are large spaces: a\quad b, a\qquad b.
    2. +
+

To set plain text, use \text{…}: \{x\in s\mid x\text{ is extra large}\}. You can nest $…$ inside of \text{…}, for example to access spaces.

+
    +
  1. +

    Accents and diacritical marks Use \hat for a single symbol \hat x, \widehat for a larger formula \widehat{xy}. If you make it too wide, it will look silly. Similarly, there are \bar \bar x and \overline \overline{xyz}, and \vec \vec x and \overrightarrow \overrightarrow{xy} and \overleftrightarrow \overleftrightarrow{xy}. For dots, as in \frac d{dx}x\dot x = \dot x^2 + x\ddot x, use \dot and \ddot.

    +
    2. +
  2. +

    Special characters used for MathJax interpreting can be escaped using the \ character: \$ \$, \{ \{, \_ \_, etc. If you want \ itself, you should use \backslash (symbol) or \setminus (binary operation) for \backslash, because \\ is for a new line.

    +
    3. +
+

(Tutorial ends here.)

+
+

It is important that this note be reasonably short and not suffer from too much bloat. To include more topics, please create short addenda and post them as answers instead of inserting them into this post.

+

Contents

+

Alphabetical list of links to To MathJax Topics, by title:

+ +

Aligned equations

+

https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference/5024#5024

+

Often people want a series of equations where the equals signs are aligned. To get this, use \begin{align}…\end{align}. Each line should end with \\, and should contain an ampersand at the point to align at, typically immediately before the equals sign.

+

For example,

+

\begin{align}
+\sqrt{37} & = \sqrt{\frac{73^2-1}{12^2}} \
+& = \sqrt{\frac{73^2}{12^2}\cdot\frac{73^2-1}{73^2}} \
+& = \sqrt{\frac{73^2}{12^2}}\sqrt{\frac{73^2-1}{73^2}} \
+& = \frac{73}{12}\sqrt{1 - \frac{1}{73^2}} \
+& \approx \frac{73}{12}\left(1 - \frac{1}{2\cdot73^2}\right)
+\end{align}

+

is produced by

+
\begin{align}
+
+

\sqrt{37} & = \sqrt{\frac{73^2-1}{12^2}} \
+& = \sqrt{\frac{73^2}{12^2}\cdot\frac{73^2-1}{73^2}} \
+& = \sqrt{\frac{73^2}{12^2}}\sqrt{\frac{73^2-1}{73^2}} \
+& = \frac{73}{12}\sqrt{1 - \frac{1}{73^2}} \
+& \approx \frac{73}{12}\left(1 - \frac{1}{2\cdot73^2}\right)
+\end{align}

+

The usual $$ marks that delimit the display may be omitted here.

+

Definitions by cases (piecewise functions)

+

https://math.meta.stackexchange.com/a/5025

+

Use \begin{cases}…\end{cases}. End each case with a \\, and use & before parts that should be aligned.

+

For example, you get this:

+
+f(n) = +\begin{cases} +n/2, & \text{if $n$ is even} \\ +3n+1, & \text{if $n$ is odd} +\end{cases} +
+

by writing this:

+
  f(n) =
+\begin{cases}
+
+

n/2, & \text{if n is even} \
+3n+1, & \text{if n is odd}
+\end{cases}

+

The brace can be moved to the right:
+$\left. +\begin{array}{l} +\text{ifnis even:}&n/2\\ +\text{ifnis odd:}&3n+1 +\end{array} +\right\} +=f(n)$
+by writing this:

+
\left.
+\begin{array}{l}
+
+

\text{if n is even:}&n/2\
+\text{if n is odd:}&3n+1
+\end{array}
+\right}
+=f(n)

+

To get a larger vertical space between cases we can use \\[2ex] instead of \\. For example, you get this:

+
+f(n) = +\begin{cases} +\frac{n}{2}, & \text{if $n$ is even} \\[2ex] +3n+1, & \text{if $n$ is odd} +\end{cases} +
+

by writing this:

+
f(n) =
+\begin{cases}
+
+

\frac{n}{2}, & \text{if n is even} \[2ex]
+3n+1, & \text{if n is odd}
+\end{cases}

+

(An ‘ex’ is a length equal to the height of the letter x; 2ex here means the space should be two exes high.)

+

Matrices

+

https://math.meta.stackexchange.com/a/5023/

+
    +
  1. +

    Use $$\begin{matrix}…\end{matrix}$$ In between the \begin and \end, put the matrix elements. End each matrix row with \\, and separate matrix elements with &. For example,

    +
     $$
+ \begin{matrix}
+ 1 & x & x^2 \\
+ 1 & y & y^2 \\
+ 1 & z & z^2 \\
+ \end{matrix}
+
    +
    2. +
+
+produces: +
+
    \begin{matrix}
+    1 & x & x^2 \\
+    1 & y & y^2 \\
+    1 & z & z^2 \\
+    \end{matrix}
+
+
+MathJax will adjust the sizes of the rows and columns so that everything fits. + +2. To add brackets, either use `\left…\right` as in section 6 of the tutorial, or replace `matrix` with `pmatrix` $\begin{pmatrix}1&2\\3&4\\ \end{pmatrix}$, `bmatrix` $\begin{bmatrix}1&2\\3&4\\ \end{bmatrix}$, `Bmatrix` $\begin{Bmatrix}1&2\\3&4\\ \end{Bmatrix}$, `vmatrix` $\begin{vmatrix}1&2\\3&4\\ \end{vmatrix}$, `Vmatrix` $\begin{Vmatrix}1&2\\3&4\\ \end{Vmatrix}$. + +3. Use `\cdots` $\cdots$ `\ddots` $\ddots$ `vdots` $\vdots$ when you want to omit some of the entries: + + $$\begin{pmatrix} + 1 & a_1 & a_1^2 & \cdots & a_1^n \\ + 1 & a_2 & a_2^2 & \cdots & a_2^n \\ + \vdots & \vdots& \vdots & \ddots & \vdots \\ + 1 & a_m & a_m^2 & \cdots & a_m^n + \end{pmatrix} +
+
    +
  1. For horizontally "augmented" matrices, put parentheses or brackets around a suitably-formatted table; see arrays below for details. Here is an example:
    2. +
+
+\left[\begin{array}{cc|c} + 1&2&3\\ + 4&5&6 + \end{array}\right] +
+

is produced by:

+
    $$ \left[
+\begin{array}{cc|c}
+  1&2&3\\
+  4&5&6
+\end{array}
+
+

\right] $$

+

The cc|c is the crucial part here; it says that there are three centered columns with a vertical bar between the second and third.

+
    +
  1. For vertically "augmented" matrices, use \hline. For example
    2. +
+
+\begin{pmatrix} +a & b \\ +c & d\\ +\hline +1 & 0\\ +0 & 1 +\end{pmatrix} +
+

is produced by

+
$$
+  \begin{pmatrix}
+    a & b\\
+    c & d\\
+  \hline
+    1 & 0\\
+    0 & 1
+  \end{pmatrix}
+$$
+
+
    +
  1. +

    For small inline matrices use \bigl(\begin{smallmatrix} ... \end{smallmatrix}\bigr), e.g. \bigl( \begin{smallmatrix} a & b \\ c & d \end{smallmatrix} \bigr) is produced by:

    +
      $\bigl( \begin{smallmatrix} a & b \\ c & d \end{smallmatrix} \bigr)$
+
    +
    2. +
+

From tactic_writing.md

+ + + +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/test/test_latex.py b/test/test_latex.py new file mode 100644 index 0000000..eeb4c7a --- /dev/null +++ b/test/test_latex.py @@ -0,0 +1,34 @@ +from markdown_it import MarkdownIt +from mdit_py_plugins.dollarmath import dollarmath_plugin +import sys +from pathlib import Path +from jinja2 import Environment, FileSystemLoader, select_autoescape + +import html +# can be removed if we make `print_docs` an installable module +sys.path.append(str(Path(__file__).parent.parent)) + +md = ( + MarkdownIt('commonmark' ,{'breaks':True,'html':True}) + .use(dollarmath_plugin) + .enable('table') +) + +env = Environment( + loader=FileSystemLoader('templates', 'utf-8'), + autoescape=select_autoescape(['html', 'xml']) +) + +def write_pure_md_file(source, dest, name): + with open(source) as infile: + body = md.render(infile.read()) + + with open(dest, 'w') as out: + out.write(env.get_template('pure_md.j2').render( + active_path = '', + name = name, + body = body, + )) + + +write_pure_md_file('test/latex.md', 'latex.html', 'LaTeX test') \ No newline at end of file