Markdown常用语法

Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。

标题

在想要设置为标题的文字前面加#来表示
一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。

注:在#后跟个空格再写文字。

示例:

1
2
3
4
5
6
# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题

字体

  • 加粗

要加粗的文字左右分别用两个*号包起来

  • 斜体

要倾斜的文字左右分别用一个*号包起来

  • 斜体加粗

要倾斜和加粗的文字左右分别用三个*号包起来

  • 删除线

要加删除线的文字左右分别用两个~~号包起来

示例:

**这是加粗的文字**
*这是倾斜的文字*`
***这是斜体加粗的文字***
~~这是加删除线的文字~~

效果:

这是加粗的文字
这是倾斜的文字`
这是斜体加粗的文字
这是加删除线的文字


引用

在引用的文字前加>即可。引用也可以嵌套,如加两个>>三个>>>

示例:

>这是引用的内容
>>这是引用的内容
>>>这是引用的内容

效果:

这是引用的内容

这是引用的内容

这是引用的内容


分割线

三个或者三个以上的 - 或者 * 都可以。

示例:

---
***

效果:



效果都一样。


超链接

示例:

[超链接名](超链接地址 "超链接title")
注:title可加可不加。
例:
[CSPMRT](https://cspmrt.github.io "CSPMT")

效果:

CSPMRT

代码块

单行代码:代码之间分别用一个`(反引号)包起来。

例如:

`代码`

多行代码:代码之间分别用三个反引号包起来,且两边的反引号单独占一行。

示例:

\```(实际使用去除\,这里是防止把反引号解析成代码块标记)
代码
\```(实际使用去除\,这里是防止把反引号解析成代码块标记)

效果:

代码

表格

语法:

1
2
3
4
5
6
7
8
9
表头|表头|表头
---|:--:|---:
内容|内容|内容|
内容|内容|内容|
第二行分割表头和内容。
- 有一个就行,为了对齐,多加了几个
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右

效果:

表头 表头 表头
内容 内容 内容
内容 内容 内容

空格

这markdown中,空格使用 表示,注意 与文字之间有一个空格。

示例:

  文字。

效果:

  文字。

数学公式

  • 注意:代码前后记得一定要加 $$$ 才可以显示效果。$$中的公式会单独占据一行,$中的公式不会单独占据一行。

1.角标 和 开方:

$c = \sqrt{a^{2}+b_{xy}^{2} +e^{x}}$

效果:

$c = \sqrt{a^{2}+b_{xy}^{2} +e^{x}}$

2.分数表达:

$\frac{x^{2}y^{2}}{x+y}$

效果:

$\frac{x^{2}y^{2}}{x+y}$

3.求和与联乘:

$$\sum_{i=0}^{n}$$
$$\prod_{i=0}^n \frac{1}{i^2}$$

效果:

$$\sum_{i=0}^{n}$$
$$\prod_{i=0}^n \frac{1}{i^2}$$

4.积分:

$$\int_0^2 x^2 {\rm d}x$$
$$\iint_0^2 x^2 {\rm d}x$$

效果:

$$\int_0^2 x^2 {\rm d}x$$
$$\iint_0^2 x^2 {\rm d}x$$

5.极限:

$$\lim\limits_{n \rightarrow +\infty} \frac{1}{n(n+1)}$$

效果:

$$\lim\limits_{n \rightarrow +\infty} \frac{1}{n(n+1)}$$

6.矢量:

$$\vec{ a }$$

效果:

$$\vec{ a }$$

7.其他:

效果 代码
$\pm$ \pm
$\times$ \times
$\div$ \div
$\mid$ \mid
$\nmid$ \nmid
$\circ$ \circ
$\leq$ \leq
$\geq$ \geq
$\neq$ \neq
$\approx$ \approx
$\equiv$ \equiv
$\coprod$ \coprod
$\emptyset$ \emptyset
$\in$ \in
$\notin$ \notin
$\subset$ \subset
$\supset$ \supset
$\subseteq$ \subseteq
$\supseteq$ \supseteq
$\bigcap$ \bigcap
$\bigcup$ \bigcup
$\bigvee$ \bigvee
$\bigwedge$ \bigwedge
$\log$ \log
$\lg$ \lg
$\ln$ \ln
$\bot$ \bot
$\angle$ \angle
$30^\circ$ 30^\circ
$\prime$ \prime
$\iiint$ \iiint
$\oint$ \oint
$\infty$ \infty
$\nabla$ \nabla
$\because$ \because
$\therefore$ \therefore
$\forall$ \forall
$\exists$ \exists
$\not=$ \not=
$\not>$ \not>
$\not\subset$ \not\subset
$\hat{y}$ \hat{y}
$\check{y}$ \check{y}
$\breve{y}$ \breve{y}
$\overline{a+b+c+d}$ \overline{a+b+c+d}
$\underline{a+b+c+d}$ \underline{a+b+c+d}
$\overbrace{a+\underbrace{b+c}_{1.0}+d}^{2.0}$ \overbrace{a+\underbrace{b+c}_{1.0}+d}^{2.0}
$\uparrow$ \uparrow
$\downarrow$ \downarrow
$\Uparrow$ \Uparrow
$\Downarrow$ \Downarrow
$\rightarrow$ \rightarrow
$\leftarrow$ \leftarrow
$\Rightarrow$ \Rightarrow
$\Leftarrow$ \Leftarrow
$\alpha$ \alpha
$\beta$ \beta
$\gamma$ \gamma
$\Gamma$ \Gamma
$\delta$ \delta
$\Delta$ \Delta
$\epsilon$ \epsilon
$\varepsilon$ \varepsilon
$\zeta$ \zeta
$\eta$ \eta
$\theta$ \theta
$\Theta$ \Theta
$\vartheta$ \vartheta
$\iota$ \iota
$\kappa$ \kappa
$\lambda$ \lambda
$\Lambda$ \Lambda
$\mu$ \mu
$\nu$ \nu
$\xi$ \xi
$\Xi$ \Xi
$\pi$ \pi
$\Pi$ \Pi
$\varpi$ \varpi
$\rho$ \rho
$\varrho$ \varrho
$\sigma$ \sigma
$\Sigma$ \Sigma
$\varsigma$ \varsigma
$\tau$ \tau
$\upsilon$ \upsilon
$\Upsilon$ \Upsilon
$\phi$ \phi
$\Phi$ \Phi
$\varphi$ \varphi
$\chi$ \chi
$\psi$ \psi
$\Psi$ \Psi
$\omega$ \omega
$\Omega$ \Omega
$\smile$ \smile
$\frown$ \frown
$\asymp$ \asymp

便签

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{% note %}
文字
{% endnote %}

{% note primary %}
primary
{% endnote %}

{% note secondary %}
secondary
{% endnote %}

{% note success %}
success
{% endnote %}

{% note danger %}
danger
{% endnote %}

{% note warning %}
warning
{% endnote %}

{% note info %}
info
{% endnote %}

{% note light %}
light
{% endnote %}

效果:

文字

primary

secondary

secondary

success

danger

warning

info

light

light

行内标签

1
{% label @ipsum %} {% label primary @primary %} {% label default @default %} {% label info @info %} {% label success @success %} {% label warning @warning %} {% label danger @danger %}

效果:

ipsum primary default info success warning danger

居中引用

1
2
{% centerquote %}Something{% endcenterquote %}
{% cq %}Something{% endcq %}

效果:

Something

Something


流程图

见: https://theme-next.js.org/docs/tag-plugins/mermaid

效果

graph TD
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]

sequenceDiagram
Alice->>John: Hello John, how are you?
loop Healthcheck
    John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!

classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label

gantt
dateFormat  YYYY-MM-DD
section Section
Completed :done,    des1, 2014-01-06,2014-01-08
Active        :active,  des2, 2014-01-07, 3d
Parallel 1   :         des3, after des1, 1d
Parallel 2   :         des4, after des1, 1d
Parallel 3   :         des5, after des3, 1d
Parallel 4   :         des6, after des4, 1d

pie
"Dogs" : 386
"Cats" : 85
"Rats" : 15

journey
title My working day
section Go to work
  Make tea: 5: Me
  Go upstairs: 3: Me
  Do work: 1: Me, Cat
section Go home
  Go downstairs: 5: Me
  Sit down: 3: Me

图片组

见:https://theme-next.js.org/docs/tag-plugins/group-pictures.html

Tabs

见:https://theme-next.js.org/docs/tag-plugins/tabs.html