Markdown 的语法全由一些符号所组成,这些符号经过精挑细选,其作用一目了然。
一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。比方说,若某一行只包含空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进。
标题
在文本前加上#
即可,一级标题使用一个#
,二级标题使用两个#
,以此类推。
区块引用
在文本前加上>
,文本前要保留一个空格。
> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.
也允许只在整个段落的第一行最前面加上>
> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.
上面两种方式的显示效果均如下:
This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.
区块应用可以嵌套,只要根据层次加上不同数量 的>
> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.
效果如下:
This is the first level of quoting.
This is nested blockquote.
Back to the first level.
列表
在列表前加上-
,为无序的。也可使用+
或者*
在列表前加上1.
2.
3.
,是有序的。即数字接英语句点。
列表项目标记通常是放在最左边,但是其实也可以缩进,最多 3 个空格,项目标记后面则一定要接着至少一个空格或制表符。
列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符。
如果要在列表项目内放进引用,那 > 就需要缩进:
* A list item with a blockquote:
> This is a blockquote
> inside a list item.
如果要放代码区块的话,该区块就需要缩进两次,也就是 8 个空格或是 2 个制表符:
* 一列表项包含一个列表区块:
<代码写在这>
分隔线
三个以上的星号***
、减号---
、底线___
来建立一个分隔线,行内不能有其他东西。也可以在星号或是减号中间插入空格。
链接
支持两种形式的链接语法: 行内式和参考式两种形式。
- 行内式
[显示文本](链接地址)
- 参考式
[显示文本][id]
在第二个方括号里面填入用以辨识链接的标记,接着,在文件的任意处,可以把这个标记的链接内容定义出来:[id]: 链接地址
链接内容定义的形式为:- 方括号(前面可以选择性地加上至多三个空格来缩进),里面输入链接文字
接着一个冒号 - 接着一个以上的空格或制表符
- 接着链接的网址
- 选择性地接着 title 内容,可以用单引号、双引号或是括弧包着
- 方括号(前面可以选择性地加上至多三个空格来缩进),里面输入链接文字
图片
同样也允许两种样式: 行内式和参考式。
- 行内式
![](图片链接地址)
- 参考式
![][id]
id是图片参考的名称,图片参考的定义方式和链接参考一样。
Markdown只能以链接形式插入图片。
代码引用
如果引用的语句只有一段,不分行,用\
置于语句前后。 如果引用的语句为多行,可以将
``` `置于这段代码的首行和末行。
粗体和斜体
粗体:用两个*
或者_
包含文字
斜体:用一个*
或者_
包含文字
表格
相关代码:
| Tables | Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
显示效果:
Tables | Are | Cool |
---|---|---|
col 3 is | right-aligned | $1600 |
col 2 is | centered | $12 |
zebra stripes | are neat | $1 |
自动链接
Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用尖括号包起来, Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样,例如:
<http://example.com/>
效果如下:
http://example.com/
反斜杠
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
\ 反斜线
` 反引号
* 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 减号
. 英文句点
! 惊叹号