这份笔记精简修改自:Markdown 语法说明 (简体中文版)
本篇主要目的为记录各种语法及其效果尝试。
字体大小(标题)
Markdown 支持两种标题的语法,类 Setext 和类 atx 形式。
-
类 Setext 形式是用底线的形式,利用
=
(最高阶标题)和-
(第二阶标题),任何数量的=
和-
都可以有效果,例如:This is an H1 ============= This is an H2 -------------
This is an H1
This is an H2
-
类 Atx 形式则是在行首插入 1 到 6 个
#
,对应到标题 1 到 6 阶,其中也可以选择性地「闭合」类 atx 样式的标题,这纯粹只是美观用的,若是觉得这样看起来比较舒适,你就可以在行尾加上#
,而行尾的#
数量也不用和开头一样(行首的井字符数量决定标题的阶数):# This is an H1 ## This is an H2 # ###### This is an H6 ###
This is an H1
This is an H2
This is an H6
区块引用 Blockquotes
在每行的最前面加上>
:
> 这是第一段说明,
> 这是第二段说明。
>
> 这是第三段说明。
这是第一段说明,
这是第二段说明。这是第三段说明。
Markdown 也允许你偷懒只在整个段落的第一行最前面加上 >
:
> 这是第一段说明,
这是第二段说明。
> 这是第三段说明。
这是第一段说明,
这是第二段说明。
这是第三段说明。
区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的 >
:
> 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.
引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等:
> ## 这是一个标题。
>
> 1. 这是第一行列表项。
> 2. 这是第二行列表项。
>
> 给出一些例子代码:
>
> return shell_exec("echo $input | $markdown_script");
这是一个标题。
- 这是第一行列表项。
- 这是第二行列表项。
给出一些例子代码:
return shell_exec("echo $input | $markdown_script");
列表
Markdown 支持有序列表和无序列表。
无序列表使用*
、+
或是-
作为列表标记,结果相同:
* Red
+ Green
- Blue
- Red
- Green
- Blue
有序列表则使用数字
接着一个英文句点
,数字不影响结果:
1. Bird
2. McHale
99. Parish
2. Elvis
- Bird
- McHale
- Parish
- Elvis
列表项目标记通常是放在最左边,但是其实也可以缩进,最多 3 个空格,项目标记后面则一定要接着至少一个空格或制表符(TAB)。
要让列表看起来更漂亮,你可以把内容用固定的缩进整理好:
* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus.
* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus. - Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.
但是如果你懒,那也行:
* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus.
* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus. - Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.
列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符,如果你每行都有缩进,看起来会看好很多,当然,Markdown 也允许懒惰版:
1. 我是段落一
我是段落二
我是段落三
2. 我是段落四
我是段落五
我是段落六
-
我是段落一
我是段落二
我是段落三 -
我是段落四
我是段落五
我是段落六
如果要在列表项目内放进引用,那 >
就需要缩进:
* A list item with a blockquote:
> This is a blockquote
> inside a list item.
-
A list item with a blockquote:
This is a blockquote
inside a list item.
如果要放代码区块的话,该区块就需要缩进两次,也就是 8 个空格或是 2 个制表符:
* 一列表项包含一个列表区块:
<代码写在这>
-
一列表项包含一个列表区块:
<代码写在这>
代码区块
缩进 4 个空格或是 1 个TAB、或是头尾使用```
包住代码:
这是一个代码区块。
```
这是两个代码区块。
```
结果如下:
这是一个代码区块。
这是两个代码区块。
如果要在代码区段内插入反引号`
,你可以用多个反引号来开启和结束代码区段:
``There is a literal backtick (`) here.``
There is a literal backtick (`) here.
代码区段的起始和结束端都可以放入一个空白,起始端后面一个,结束端前面一个,这样你就可以在区段的一开始就插入反引号:
A single backtick in a code span: `` ` ``
A backtick-delimited string in a code span: `` `foo` ``
A single backtick in a code span: `
A backtick-delimited string in a code span: `foo`
分隔线
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
* * *
***
*****
- - -
---------------------------------------
链接
Markdown 支持两种形式的链接语法: 行内式和参考式两种形式。
不管是哪一种,链接文字都是用 [
方括号 ]
来标记。
要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:
This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.com/) has no title attribute.
This is an example inline link.
This link has no title attribute.
如果你是要链接到同样主机的资源,你可以使用相对路径:
See my [About](/about/) page for details.
See my About page for details.
参考式的链接是在链接文字的括号后面再接上另一个方括号,而在第二个方括号里面要填入用以辨识链接的标记,你也可以选择性地在两个方括号中间加上一个空格:
This is [an example][id] reference-style link.
This is [an example] [id] reference-style link.
This is an example reference-style link.
This is an example reference-style link.
接着,在文件的任意处,你可以把这个标记的链接内容定义出来:
[id]: http://example.com/ "Optional Title Here"
链接内容定义的形式为:
- 方括号(前面可以选择性地加上至多三个空格来缩进),里面输入链接文字
- 接着一个冒号
- 接着一个以上的空格或TAB
- 接着链接的网址
- 选择性地接着 title 内容,可以用单引号、双引号或是括弧包着
下面这三种链接的定义都是相同:
[foo]: http://example.com/ "Optional Title Here"
[foo]: http://example.com/ 'Optional Title Here'
[foo]: http://example.com/ (Optional Title Here)
请注意:有一个已知的问题是 Markdown.pl 1.0.1 会忽略单引号包起来的链接 title。
链接网址也可以用方括号包起来:
[id]: <http://example.com/> "Optional Title Here"
你也可以把 title 属性放到下一行,也可以加一些缩进,若网址太长的话,这样会比较好看:
[id]: http://example.com/longish/path/to/resource/here
"Optional Title Here"
网址定义只有在产生链接的时候用到,并不会直接出现在文件之中。
链接辨别标签可以有字母、数字、空白和标点符号,但是并不区分大小写,因此下面两个链接是一样的:
[link text][a]
[link text][A]
隐式链接标记功能让你可以省略指定链接标记,这种情形下,链接标记会视为等同于链接文字,要用隐式链接标记只要在链接文字后面加上一个空的方括号,如果你要让 "Google" 链接到 google.com,你可以简化成:
[Google][]
然后定义链接内容:
[Google]: http://google.com/
由于链接文字可能包含空白,所以这种简化型的标记内也许包含多个单词:
Visit [Daring Fireball][] for more information.
Visit Daring Fireball for more information.
然后接着定义链接:
[Daring Fireball]: http://daringfireball.net/
链接的定义可以放在文件中的任何一个地方,原作者比较偏好直接放在链接出现段落的后面,你也可以把它放在文件最后面,就像是注解一样。
下面是一个参考式链接的范例:
I get 10 times more traffic from [Google] [1] than from
[Yahoo] [2] or [MSN] [3].
[1]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[3]: http://search.msn.com/ "MSN Search"
I get 10 times more traffic from Google than from
Yahoo or MSN.
如果改成用链接名称的方式写:
I get 10 times more traffic from [Google][] than from
[Yahoo][] or [MSN][].
[google]: http://google.com/ "Google"
[yahoo]: http://search.yahoo.com/ "Yahoo Search"
[msn]: http://search.msn.com/ "MSN Search"
I get 10 times more traffic from Google than from
Yahoo or MSN.
上面两种写法产生的结果一样。
下面是用行内式写的同样一段内容的 Markdown 文件,提供作为比较之用:
I get 10 times more traffic from [Google](http://google.com/ "Google")
than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or
[MSN](http://search.msn.com/ "MSN Search").
参考式的链接其实重点不在于它比较好写,而是它比较好读,比较一下上面的范例,使用参考式的文章本身只有 81 个字符,但是用行内形式的却会增加到 176 个字元,如果是用纯 HTML 格式来写,会有 234 个字元,在 HTML 格式中,标签比文本还要多。
使用 Markdown 的参考式链接,可以让文件更像是浏览器最后产生的结果,让你可以把一些标记相关的元数据移到段落文字之外,你就可以增加链接而不让文章的阅读感觉被打断。
自动链接
Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用方括号包起来, Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样,例如:
<http://example.com/>
邮址的自动链接也很类似,例如:
<address@example.com>
强调
Markdown 使用星号*
和底线_
和波浪~
作为标记强调字词的符号:
正常
~小字~
~~删除线~~
*斜体*
**粗体**
___粗斜体1___
***粗斜体2***
正常
小字
删除线
斜体
粗体
粗斜体1
粗斜体2
你可以随便用你喜欢的样式,唯一的限制是,你用什么符号开启标签,就要用什么符号结束。
强调也可以直接插在文字中间:
un*frigging*believable
unfriggingbelievable
但是如果你的*
和 _
两边都有空白的话,它们就只会被当成普通的符号。
如果要在文字前后直接插入普通的星号或底线,你可以用反斜线:
\*this text is surrounded by literal asterisks\*
*this text is surrounded by literal asterisks*
上下标
-
上标:
注释<sup>1</sup>
注释1
-
下标:
H<sub>2</sub>O
H2O
图片
Markdown 使用一种和链接很相似的语法来标记图片,同样也允许两种样式: 行内式和参考式。
详细叙述如下:
- 一个惊叹号
!
- 接着一个方括号,里面放上图片的替代文字
- 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 'title' 文字。
![Alt text][id]
Alt text
「id」是图片参考的名称,图片参考的定义方式则和连结参考一样:
[id]: url/to/image "Optional title attribute"
插入符号
Markdown 可以利用反斜杠\
来插入一些在语法中有其它意义的符号,例如:如果你想要用星号加在文字旁边的方式来做出强调效果,你可以在星号的前面加上反斜杠:
\*literal asterisks\*
*literal asterisks*
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
\ 反斜线
` 反引号
* 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 减号
. 英文句点
! 惊叹号
表格示范
|表头|表头|表头|
|-:|:-:|:-|
|右对齐|居中|左对齐|
|1|2|3|
表头 | 表头 | 表头 |
---|---|---|
右对齐 | 居中 | 左对齐 |
1 | 2 | 3 |
句首空格
前面是四个空格
前面是四个空格
脚注
脚注相关规则参阅参考式链接:
我需要脚注[^1]
今天天气不错
我来自哪里[^apple]
明天天气不错
脚注你是谁[^88]
[^1]: 脚注来了
[^88]: 我不认识你
[^apple]: 天津
我需要脚注[1]
今天天气不错
我来自哪里[2]
明天天气不错
脚注你是谁[3]
网友评论