docs: add more content in Mathematics and fix some typos (#1306)
1. Add docs for block math and inline math 2. Change a grammar mistake at line 137, the single form should be used 3. Change the comma from Chinese to English for consistency of the doc. --------- Co-authored-by: Cotes Chung <11371340+cotes2020@users.noreply.github.com>
This commit is contained in:
parent
50835b4c71
commit
d71711d2d3
1 changed files with 26 additions and 2 deletions
|
@ -107,9 +107,33 @@ math: true
|
||||||
---
|
---
|
||||||
```
|
```
|
||||||
|
|
||||||
|
After enabling the mathematical feature, you can add math equations with the following syntax:
|
||||||
|
|
||||||
|
- **Block math** should be added with `$$ math $$` with **mandatory** blank lines before and after `$$`
|
||||||
|
- **Inline math** (in lines) should be added with `$$ math $$` without any blank line before or after `$$`
|
||||||
|
- **Inline math** (in lists) should be added with `\$$ math $$`
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
<!-- Block math, keep all blank lines -->
|
||||||
|
|
||||||
|
$$
|
||||||
|
LaTeX_math_expression
|
||||||
|
$$
|
||||||
|
|
||||||
|
<!-- Inline math in lines, NO blank lines -->
|
||||||
|
|
||||||
|
"Lorem ipsum dolor sit amet, $$ LaTeX_math_expression $$ consectetur adipiscing elit."
|
||||||
|
|
||||||
|
<!-- Inline math in lists, escape the first `$` -->
|
||||||
|
|
||||||
|
1. \$$ LaTeX_math_expression $$
|
||||||
|
2. \$$ LaTeX_math_expression $$
|
||||||
|
3. \$$ LaTeX_math_expression $$
|
||||||
|
```
|
||||||
|
|
||||||
## Mermaid
|
## Mermaid
|
||||||
|
|
||||||
[**Mermaid**](https://github.com/mermaid-js/mermaid) is a great diagrams generation tool. To enable it on your post, add the following to the YAML block:
|
[**Mermaid**](https://github.com/mermaid-js/mermaid) is a great diagram generation tool. To enable it on your post, add the following to the YAML block:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
---
|
---
|
||||||
|
@ -123,7 +147,7 @@ Then you can use it like other markdown languages: surround the graph code with
|
||||||
|
|
||||||
### Caption
|
### Caption
|
||||||
|
|
||||||
Add italics to the next line of an image,then it will become the caption and appear at the bottom of the image:
|
Add italics to the next line of an image, then it will become the caption and appear at the bottom of the image:
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
![img-description](/path/to/image)
|
![img-description](/path/to/image)
|
||||||
|
|
Loading…
Reference in a new issue