Skip to content

Commit 9456b23

Browse files
authored
docs(website): change recommended syntax for math equations (#11784)
1 parent 2f617b7 commit 9456b23

12 files changed

Lines changed: 131 additions & 37 deletions

File tree

website/docs/guides/markdown-features/markdown-features-math-equations.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,15 @@ Let $f\colon[a,b] \to \R$ be Riemann integrable. Let $F\colon[a,b]\to\R$ be $F(x
3535

3636
### Blocks {#blocks}
3737

38-
For equation block or display mode, use line breaks and `$$`:
38+
For equation block or display mode, use <code>```math</code> fenced code blocks.
39+
40+
````latex
41+
```math
42+
I = \int_0^{2\pi} \sin(x)\,dx
43+
```
44+
````
45+
46+
You can also use line breaks and `$$`, although this syntax relies on a [Markdown syntax extension](https://github.com/micromark/micromark-extension-math) and is less portable:
3947

4048
```latex
4149
$$
@@ -45,9 +53,9 @@ $$
4553

4654
<BrowserWindow>
4755

48-
$$
56+
```math
4957
I = \int_0^{2\pi} \sin(x)\,dx
50-
$$
58+
```
5159

5260
</BrowserWindow>
5361

website/versioned_docs/version-2.x/guides/markdown-features/markdown-features-math-equations.mdx

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,15 @@ Let $f\colon[a,b] \to \R$ be Riemann integrable. Let $F\colon[a,b]\to\R$ be $F(x
3131

3232
</BrowserWindow>
3333

34-
### Blocks {#blocks}
34+
For equation block or display mode, use <code>```math</code> fenced code blocks.
3535

36-
For equation block or display mode, use line breaks and `$$`:
36+
````latex
37+
```math
38+
I = \int_0^{2\pi} \sin(x)\,dx
39+
```
40+
````
41+
42+
You can also use line breaks and `$$`, although this syntax relies on a [Markdown syntax extension](https://github.com/micromark/micromark-extension-math) and is less portable:
3743

3844
```latex
3945
$$
@@ -43,9 +49,9 @@ $$
4349

4450
<BrowserWindow>
4551

46-
$$
52+
```math
4753
I = \int_0^{2\pi} \sin(x)\,dx
48-
$$
54+
```
4955

5056
</BrowserWindow>
5157

website/versioned_docs/version-3.0.1/guides/markdown-features/markdown-features-math-equations.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ Let $f\colon[a,b] \to \R$ be Riemann integrable. Let $F\colon[a,b]\to\R$ be $F(x
3333

3434
### Blocks {#blocks}
3535

36-
For equation block or display mode, use line breaks and `$$`:
36+
For equation block or display mode, use <code>```math</code> fenced code blocks.
37+
38+
````latex
39+
```math
40+
I = \int_0^{2\pi} \sin(x)\,dx
41+
```
42+
````
43+
44+
You can also use line breaks and `$$`, although this syntax relies on a [Markdown syntax extension](https://github.com/micromark/micromark-extension-math) and is less portable:
3745

3846
```latex
3947
$$
@@ -43,9 +51,9 @@ $$
4351

4452
<BrowserWindow>
4553

46-
$$
54+
```math
4755
I = \int_0^{2\pi} \sin(x)\,dx
48-
$$
56+
```
4957

5058
</BrowserWindow>
5159

website/versioned_docs/version-3.1.1/guides/markdown-features/markdown-features-math-equations.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ Let $f\colon[a,b] \to \R$ be Riemann integrable. Let $F\colon[a,b]\to\R$ be $F(x
3333

3434
### Blocks {#blocks}
3535

36-
For equation block or display mode, use line breaks and `$$`:
36+
For equation block or display mode, use <code>```math</code> fenced code blocks.
37+
38+
````latex
39+
```math
40+
I = \int_0^{2\pi} \sin(x)\,dx
41+
```
42+
````
43+
44+
You can also use line breaks and `$$`, although this syntax relies on a [Markdown syntax extension](https://github.com/micromark/micromark-extension-math) and is less portable:
3745

3846
```latex
3947
$$
@@ -43,9 +51,9 @@ $$
4351

4452
<BrowserWindow>
4553

46-
$$
54+
```math
4755
I = \int_0^{2\pi} \sin(x)\,dx
48-
$$
56+
```
4957

5058
</BrowserWindow>
5159

website/versioned_docs/version-3.2.1/guides/markdown-features/markdown-features-math-equations.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ Let $f\colon[a,b] \to \R$ be Riemann integrable. Let $F\colon[a,b]\to\R$ be $F(x
3333

3434
### Blocks {#blocks}
3535

36-
For equation block or display mode, use line breaks and `$$`:
36+
For equation block or display mode, use <code>```math</code> fenced code blocks.
37+
38+
````latex
39+
```math
40+
I = \int_0^{2\pi} \sin(x)\,dx
41+
```
42+
````
43+
44+
You can also use line breaks and `$$`, although this syntax relies on a [Markdown syntax extension](https://github.com/micromark/micromark-extension-math) and is less portable:
3745

3846
```latex
3947
$$
@@ -43,9 +51,9 @@ $$
4351

4452
<BrowserWindow>
4553

46-
$$
54+
```math
4755
I = \int_0^{2\pi} \sin(x)\,dx
48-
$$
56+
```
4957

5058
</BrowserWindow>
5159

website/versioned_docs/version-3.3.2/guides/markdown-features/markdown-features-math-equations.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ Let $f\colon[a,b] \to \R$ be Riemann integrable. Let $F\colon[a,b]\to\R$ be $F(x
3333

3434
### Blocks {#blocks}
3535

36-
For equation block or display mode, use line breaks and `$$`:
36+
For equation block or display mode, use <code>```math</code> fenced code blocks.
37+
38+
````latex
39+
```math
40+
I = \int_0^{2\pi} \sin(x)\,dx
41+
```
42+
````
43+
44+
You can also use line breaks and `$$`, although this syntax relies on a [Markdown syntax extension](https://github.com/micromark/micromark-extension-math) and is less portable:
3745

3846
```latex
3947
$$
@@ -43,9 +51,9 @@ $$
4351

4452
<BrowserWindow>
4553

46-
$$
54+
```math
4755
I = \int_0^{2\pi} \sin(x)\,dx
48-
$$
56+
```
4957

5058
</BrowserWindow>
5159

website/versioned_docs/version-3.4.0/guides/markdown-features/markdown-features-math-equations.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ Let $f\colon[a,b] \to \R$ be Riemann integrable. Let $F\colon[a,b]\to\R$ be $F(x
3333

3434
### Blocks {#blocks}
3535

36-
For equation block or display mode, use line breaks and `$$`:
36+
For equation block or display mode, use <code>```math</code> fenced code blocks.
37+
38+
````latex
39+
```math
40+
I = \int_0^{2\pi} \sin(x)\,dx
41+
```
42+
````
43+
44+
You can also use line breaks and `$$`, although this syntax relies on a [Markdown syntax extension](https://github.com/micromark/micromark-extension-math) and is less portable:
3745

3846
```latex
3947
$$
@@ -43,9 +51,9 @@ $$
4351

4452
<BrowserWindow>
4553

46-
$$
54+
```math
4755
I = \int_0^{2\pi} \sin(x)\,dx
48-
$$
56+
```
4957

5058
</BrowserWindow>
5159

website/versioned_docs/version-3.5.2/guides/markdown-features/markdown-features-math-equations.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ Let $f\colon[a,b] \to \R$ be Riemann integrable. Let $F\colon[a,b]\to\R$ be $F(x
3333

3434
### Blocks {#blocks}
3535

36-
For equation block or display mode, use line breaks and `$$`:
36+
For equation block or display mode, use <code>```math</code> fenced code blocks.
37+
38+
````latex
39+
```math
40+
I = \int_0^{2\pi} \sin(x)\,dx
41+
```
42+
````
43+
44+
You can also use line breaks and `$$`, although this syntax relies on a [Markdown syntax extension](https://github.com/micromark/micromark-extension-math) and is less portable:
3745

3846
```latex
3947
$$
@@ -43,9 +51,9 @@ $$
4351

4452
<BrowserWindow>
4553

46-
$$
54+
```math
4755
I = \int_0^{2\pi} \sin(x)\,dx
48-
$$
56+
```
4957

5058
</BrowserWindow>
5159

website/versioned_docs/version-3.6.3/guides/markdown-features/markdown-features-math-equations.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ Let $f\colon[a,b] \to \R$ be Riemann integrable. Let $F\colon[a,b]\to\R$ be $F(x
3333

3434
### Blocks {#blocks}
3535

36-
For equation block or display mode, use line breaks and `$$`:
36+
For equation block or display mode, use <code>```math</code> fenced code blocks.
37+
38+
````latex
39+
```math
40+
I = \int_0^{2\pi} \sin(x)\,dx
41+
```
42+
````
43+
44+
You can also use line breaks and `$$`, although this syntax relies on a [Markdown syntax extension](https://github.com/micromark/micromark-extension-math) and is less portable:
3745

3846
```latex
3947
$$
@@ -43,9 +51,9 @@ $$
4351

4452
<BrowserWindow>
4553

46-
$$
54+
```math
4755
I = \int_0^{2\pi} \sin(x)\,dx
48-
$$
56+
```
4957

5058
</BrowserWindow>
5159

website/versioned_docs/version-3.7.0/guides/markdown-features/markdown-features-math-equations.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,15 @@ Let $f\colon[a,b] \to \R$ be Riemann integrable. Let $F\colon[a,b]\to\R$ be $F(x
3333

3434
### Blocks {#blocks}
3535

36-
For equation block or display mode, use line breaks and `$$`:
36+
For equation block or display mode, use <code>```math</code> fenced code blocks.
37+
38+
````latex
39+
```math
40+
I = \int_0^{2\pi} \sin(x)\,dx
41+
```
42+
````
43+
44+
You can also use line breaks and `$$`, although this syntax relies on a [Markdown syntax extension](https://github.com/micromark/micromark-extension-math) and is less portable:
3745

3846
```latex
3947
$$
@@ -43,9 +51,9 @@ $$
4351

4452
<BrowserWindow>
4553

46-
$$
54+
```math
4755
I = \int_0^{2\pi} \sin(x)\,dx
48-
$$
56+
```
4957

5058
</BrowserWindow>
5159

0 commit comments

Comments
 (0)