Markdown Operating Guide
**Preface: ** This is the Markdown tutorial written by Typora.And partial syntax functions need to be turned on in Settings.
Author: Lemonade_ J J
Time: 2022/6/9
Headline
There are six levels of headings.
For the first level, you must use “#” and " ".
# Headline
If you want to reduce the font size, you can add the number of the “#”.
Quote
This part is prefixed with a "> ".
> This is a quota.
This is a quota.
List
- Unordered List: This part is prefixed with a "* " for a filled dot or "- " and "+ " for a hollow dot.
2. Ordered List: This part is prefixed with a number.- Task List: This part is prefixed with a "- [ ] ". Pay attention to the blank after the “-” and “[”.
* Unordered List:
- Unordered List:
+ Unordered List:
2. Ordered List:
- [ ] Task List:
Stylized Font
-
Strike-through: Add “~~” before and after the text to be modified.
~~This is a case.~~
-
Italic type: Add “*” before and after the text to be modified.
*This is a case.*
-
Bold type: Add “**” before and after the text to be modified.
**This is a case.**
-
Italic and Bold type: Add “***” before and after the text to be modified.
***This is a case.***
-
Underline: Enter the content in the “”.
<u>This is a case.</u>
This is a case.
-
Highlight: Add “==” before and after the text to be modified.
==This is a case.==
This is a case.
-
Superscript: Add “^” before and after the text to be modified.
2^x^
2x
-
Subscript: Add “~” before and after the text to be modified.
H~2~O
H2O
-
Emphasis: Add “`” before and after the text to be modified.
`This is a case.`
This is a case.
-
Hyperlink:
- External jump: Enter the content in the “[ ]" and put the links to sites in the “( )”.
[This is a case.](https://www.latexlive.com/)
- Internal jump: Enter the content in the “[ ]" and put the title of this document in the ( )".
[This is a case.](##Stylized Font)
[This is a case.](##Stylized Font)
- Automatic jump: Put the links to sites in the “< >”.
<https://www.latexlive.com/>
And if you want to access to the site, you should hold down the CTRL key and click on the hyperlink.
Code Block
Use “```” and programming language types.
“```python”:
import pytorch
“```C++”
#include <iostream>
“```markdown”
> This is a quota.
Form
Use “|” to separate different cells and “-” to separate table headers and cell rows.
| name | price |
| :-----------: | :---: |
| fried chicken | 19 |
| cola | 32 |
name | price |
---|---|
fried chicken | 19 |
cola | 32 |
You can use “:” to mark the alignment of the contents of the cells below.
-
Left:
:----
-
Middle:
:----:
-
Right:
----:
Mathematical Expressions
You can render LaTeX mathematical expressions using LaTeX:
- Inline formula: Add “$” before and after the mathematical expressions.
$\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$
Γ ( n ) = ( n − 1 ) ! ∀ n ∈ N \Gamma(n) = (n-1)!\quad\forall n\in\mathbb N Γ(n)=(n−1)!∀n∈N
- Independent formula: Add “$$” before and after the mathematical expressions.
$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,
$$
Γ ( z ) = ∫ 0 ∞ t z − 1 e − t d t . \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,. Γ(z)=∫0∞tz−1e−tdt.
You can find more information about LaTeX mathematical expressions here.
UML diagrams
You can render UML diagrams using Mermaid. For example, this will produce a sequence diagram:
- The prefix is “```mermaid”;
- After the break add “sequenceDiagram” as the type of figure;
- Enter the content;
- The suffix is “```”。
```mermaid
sequenceDiagram
Alice ->> Bob: Hello Bob, how are you?
Bob-->>John: How about you John?
Bob--x Alice: I am good thanks!
Bob-x John: I am good thanks!
Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.
Bob-->>Alice: Checking with John...
Alice->>John: Yes... John, how are you?
```
And this will produce a flow chart:
- Change the type of figure to “graph”, and you can add the direction of the figure like “LR” or “RL”.
```mermaid
graph LR
A[Square Rect] -- Link text --> B((Circle))
A --> C(Round Rect)
B --> D{Rhombus}
C --> D
D --> E[(Cylinder)]
A --> F([Ellipse])
```