还在为记不住Markdown语法犯愁？收藏这篇文章吧！

本文已同步发表到个人技术微信公众号，扫一扫文章底部的二维码或在微信搜索 “程序员驿站”便可关注，不按期更新优质技术文章。同时，也欢迎加入QQ技术群（群号：650306310）一块儿交流学习！

最近在用Markdown记录生活，发现有些语法总记不住，特此写下这篇文字，方便本身查阅。若是有和我状况同样的小伙伴，欢迎查阅或收藏这篇文章！讲解顺序和官方一致！

概述

本篇文章基于：Markdown 语法说明 (简体中文版) 的说明和例子实践以后所写，文章所用文字多摘录于官方文档。

文中描述文字中用到的HTML标签均在方括号"<>"中字母前加了空格，防止被Markdown编译器识别，如 < div>。

宗旨

Markdown 的目标是实现「易读易写」。

可读性，不管如何，都是最重要的。一份使用Markdown格式撰写的文件应该能够直接以纯文本发布，而且看起来不会像是由许多标签或是格式指令所构成。Markdown语法受到一些既有text-to-HTML格式的影响，包括 Setext、atx、Textile、reStructuredText、Grutatext和EtText，而最大灵感来源实际上是纯文本电子邮件的格式。
总之， Markdown的语法全由一些符号所组成，这些符号通过精挑细选，其做用一目了然。好比：在文字两旁加上星号，看起来就像*强调*。Markdown的列表看起来，嗯，就是列表。Markdown的区块引用看起来就真的像是引用一段文字，就像你曾在电子邮件中见过的那样.

Markdown 不是想要取代HTML，甚至也没有要和它相近，它的语法种类不多，只对应 HTML 标记的一小部分。Markdown的构想不是要使得HTML文档更容易书写。在我看来， HTML 已经很容易写了。Markdown的理念是，能让文档更容易读、写和随意改。HTML 是一种发布的格式，Markdown是一种书写的格式。就这样，Markdown 的格式语法只涵盖纯文本能够涵盖的范围。

不在 Markdown 涵盖范围以内的标签，均可以直接在文档里面用HTML撰写。不须要额外标注这是 HTML 或是 Markdown；只要直接加标签就能够了。

要制约的只有一些 HTML区块元素――好比< div>、< table>、< pre>、< p>等标签，必须在先后加上空行与其它内容区隔开，还要求它们的开始标签与结尾标签不能用制表符或空格来缩进。Markdown 的生成器有足够智能，不会在 HTML 区块标签外加上没必要要的 < p> 标签。

例子以下，在 Markdown 文件里加上一段 HTML 表格：

对应效果：

请注意，在 HTML 区块标签间的 Markdown 格式语法将不会被处理。好比，你在 HTML 区块内使用 Markdown 样式的*强调*会没有效果。

HTML 的区段（行内）标签如 < span>、< cite>、< del> 能够在 Markdown 的段落、列表或是标题里随意使用。依照我的习惯，甚至能够不用 Markdown 格式，而直接采用 HTML 标签来格式化。举例说明：若是比较喜欢 HTML 的 < a> 或 < img> 标签，能够直接使用这些标签，而不用 Markdown 提供的连接或是图像标签语法。

和处在 HTML 区块标签间不一样，Markdown 语法在 HTML 区段标签间是有效的。

特殊字符自动转换

在 HTML 文件中，有两个字符须要特殊处理： < 和 & 。 < 符号用于起始标签，& 符号则用于标记 HTML 实体，若是你只是想要显示这些字符的原型，你必需要使用实体的形式，像是 &lt; 和 &amp;。

& 字符尤为让网络文档编写者受折磨，若是你要打「AT&T」 ，你必需要写成「AT&amp;T」。而网址中的 & 字符也要转换。好比你要连接到： http://images.google.com/images?num=30&q=larry+bird
你必需要把网址转换写为： http://images.google.com/images?num=30&q=larry+bird
才能放到连接标签的 href 属性里。不用说也知道这很容易忽略，这也多是 HTML 标准检验所检查到的错误中，数量最多的。

Markdown 让你能够天然地书写字符，须要转换的由它来处理好了。若是你使用的 & 字符是 HTML 字符实体的一部分，它会保留原状，不然它会被转换成 &amp ; 。

因此你若是要在文档中插入一个版权符号©，你能够这样写：

©
复制代码

Markdown 会保留它不动。而若你写：

AT&T
复制代码

Markdown 就会将它转为：

AT&T
复制代码

相似的情况也会发生在 < 符号上，由于 Markdown 容许 兼容 HTML ，若是你是把 < 符号做为 HTML 标签的定界符使用，那 Markdown 也不会对它作任何转换，可是若是你写：

4 < 5
复制代码

Markdown 将会把它转换为：

4 < 5
复制代码

不过须要注意的是，code 范围内，不管是行内仍是区块， < 和 & 两个符号都必定会被转换成 HTML 实体，这项特性让你能够很容易地用 Markdown 写 HTML code （和 HTML 相对而言， HTML 语法中，你要把全部的 < 和 & 都转换为 HTML 实体，才能在 HTML 文件里面写出 HTML code。）

区块元素

段落和换行

有一个以上的空行（空行的定义是显示上看起来像是空的，便会被视为空行。比方说，若某一行只包含空格和制表符，则该行也会被视为空行）。普通段落不应用空格或制表符来缩进。

「由一个或多个连续的文本行组成」这句话其实暗示了 Markdown 容许段落内的强迫换行（插入换行符），这个特性和其余大部分的 text-to-HTML 格式不同（包括 Movable Type 的「Convert Line Breaks」选项），其它的格式会把每一个换行符都转成 < br /> 标签。

若是你确实想要依赖 Markdown 来插入 < br /> 标签的话，在插入处先按入两个以上的空格而后回车。

的确，须要多费点事（多加空格）来产生 < br /> ，可是简单地「每一个换行都转换为 < br />」的方法在 Markdown 中并不适合， Markdown 中 email 式的 区块引用 和多段落的 列表 在使用换行来排版的时候，不但更好用，还更方便阅读。

标题

Markdown 支持两种标题的语法，类 Setext 和类 atx 形式。

类 Setext 形式是用底线的形式，利用 = （最高阶标题）和 - （第二阶标题），例如：

This is an H1
=============
This is an H2
-------------
复制代码

效果为：

任何数量的 = 和 - 均可以有效果。

类 Atx 形式则是在行首插入 1 到 6 个 # ，对应到标题 1 到 6 阶，例如：

# 这是 H1

## 这是 H2

###### 这是 H6
复制代码

效果为：

你能够选择性地「闭合」类 atx 样式的标题，这纯粹只是美观用的，如果以为这样看起来比较温馨，你就能够在行尾加上 #，而行尾的 # 数量也不用和开头同样（行首的井字符数量决定标题的阶数）：

# 这是 H1 #

## 这是 H2 ##

### 这是 H3 ######
---
复制代码

效果为：

区块引用 Blockquotes

Markdown 标记区块引用是使用相似 email 中用 > 的引用方式。若是你还熟悉在 email 信件中的引言部分，你就知道怎么在 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.
复制代码

效果为：

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.

复制代码

效果为：

区块引用能够嵌套（例如：引用内的引用），只要根据层次加上不一样数量的 > ：

> ## 这是一个标题。
> 
> 1.   这是第一行列表项。
> 2.   这是第二行列表项。
> 
> 给出一些例子代码：
> 
>     return shell_exec("echo $input | $markdown_script");
复制代码

效果为：

任何像样的文本编辑器都能轻松地创建 email 型的引用。例如在 BBEdit 中，你能够选取文字后而后从选单中选择增长引用阶层。

列表

Markdown 支持有序列表和无序列表。 无序列表使用星号、加号或是减号做为列表标记：

*   Red
*   Green
*   Blue

等同于：
+   Red
+   Green
+   Blue

也等同于：
-   Red
-   Green
-   Blue
复制代码

效果为：

有序列表则使用数字接着一个英文句点：

1.  Bird
2.  McHale
3.  Parish 
复制代码

效果为：

很重要的一点是，你在列表标记上使用的数字并不会影响输出的 HTML 结果，上面的列表所产生的 HTML 标记为：

<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>
复制代码

效果为：

若是你的列表标记写成：

效果为：

你都会获得彻底相同的 HTML 输出。重点在于，你可让 Markdown 文件的列表数字和输出的结果相同，或是你懒一点，你能够彻底不用在乎数字的正确性。

若是你使用懒惰的写法，建议第一个项目最好仍是从 1. 开始，由于 Markdown 将来可能会支持有序列表的 start 属性。

列表项目标记一般是放在最左边，可是其实也能够缩进，最多 3 个空格，项目标记后面则必定要接着至少一个空格或制表符。

要让列表看起来更漂亮，你能够把内容用固定的缩进整理好：

*   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.
复制代码

效果为：

可是若是你懒，那也行：

*   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
复制代码

效果为：

若是列表项目间用空行分开，在输出 HTML 时 Markdown 就会将项目内容用 < p> 标签包起来，举例来讲：

效果为：

列表项目能够包含多个段落，每一个项目下的段落都必须缩进 4 个空格或是 1 个制表符：

1.  This is a list item 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.

2.  Suspendisse id sem consectetuer libero luctus adipiscing.

复制代码

效果为：

若是你每行都有缩进，看起来会看好不少，固然，再次地，若是你很懒惰，Markdown 也容许：

*   This is a list item with two paragraphs.

    This is the second paragraph in the list item. You're only required to indent the first line. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. * Another item in the same list. 复制代码

效果为：

若是要在列表项目内放进引用，那 > 就须要缩进:

*   A list item with a blockquote:

    > This is a blockquote
    > inside a list item.
复制代码

效果为：

若是要放代码区块的话，该区块就须要缩进两次，也就是 8 个空格或是 2 个制表符：

*   一列表项包含一个列表区块：

        <代码写在这>
复制代码

效果为：

固然，项目列表极可能会不当心产生，像是下面这样的写法：

1986. What a great season.
复制代码

效果为：

换句话说，也就是在行首出现数字-句点-空白，要避免这样的情况，你能够在句点前面加上反斜杠。

1986\. What a great season.
复制代码

效果为：

代码区块

和程序相关的写做或是标签语言原始码一般会有已经排版好的代码区块，一般这些区块咱们并不但愿它以通常段落文件的方式去排版，而是照原来的样子显示，Markdown 会用 < pre> 和 < code> 标签来把代码区块包起来。

效果为：

这个每行一阶的缩进（4 个空格或是 1 个制表符），都会被移除，例如：

效果为：

一个代码区块会一直持续到没有缩进的那一行（或是文件结尾）。

在代码区块里面， & 、 < 和 > 会自动转成 HTML 实体，这样的方式让你很是容易使用 Markdown 插入范例用的 HTML 原始码，只须要复制贴上，再加上缩进就能够了，剩下的 Markdown 都会帮你处理，例如：

效果为：

代码区块中，通常的 Markdown 语法不会被转换，像是星号便只是星号，这表示你能够很容易地以 Markdown 语法撰写 Markdown 语法相关的文件。

分隔线

你能够在一行中用三个以上的星号、减号、底线来创建一个分隔线，行内不能有其余东西。你也能够在星号或是减号中间插入空格。下面每种写法均可以创建分隔线：

效果为：

区段元素

连接

Markdown 支持两种形式的连接语法： 行内式和参考式两种形式。

无论是哪种，连接文字都是用 [方括号] 来标记。

要创建一个行内式的连接，只要在方块括号后面紧接着圆括号并插入网址连接便可，若是你还想要加上连接的 title 文字，只要在网址后面，用双引号把 title 文字包起来便可，例如：

效果为：

若是你是要连接到一样主机的资源，你可使用相对路径：

效果为：

参考式的连接是在连接文字的括号后面再接上另外一个方括号，而在第二个方括号里面要填入用以辨识连接的标记：

效果为：

连接内容定义的形式为：

• 方括号（前面能够选择性地加上至多三个空格来缩进），里面输入连接文字
• 接着一个冒号
• 接着一个以上的空格或制表符
• 接着连接的网址
• 选择性地接着 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，你能够简化成：

效果为：

因为连接文字可能包含空白，因此这种简化型的标记内也许包含多个单词：

效果为：

连接的定义能够放在文件中的任何一个地方，我比较偏好直接放在连接出现段落的后面，你也能够把它放在文件最后面，就像是注解同样。

下面是一个参考式连接的范例：

运行效果图：

参考式的连接其实重点不在于它比较好写，而是它比较好读，比较一下上面的范例，使用参考式的文章自己只有 81 个字符，可是用行内形式的却会增长到 176 个字元，若是是用纯 HTML 格式来写，会有 234 个字元，在 HTML 格式中，标签比文本还要多。

使用 Markdown 的参考式连接，可让文件更像是浏览器最后产生的结果，让你能够把一些标记相关的元数据移到段落文字以外，你就能够增长连接而不让文章的阅读感受被打断。

强调

Markdown 使用星号（*）和底线（_）做为标记强调字词的符号，被 * 或 _ 包围的字词会被转成用 < em> 标签包围，用两个 * 或 _ 包起来的话，则会被转成 < strong>，例如：

效果为：

你能够随便用你喜欢的样式，惟一的限制是，你用什么符号开启标签，就要用什么符号结束。

强调也能够直接插在文字中间：

un*frigging*believable
复制代码

效果为：

可是若是你的 * 和 _ 两边都有空白的话，它们就只会被当成普通的符号。

若是要在文字先后直接插入普通的星号或底线，你能够用反斜线：

\*this text is surrounded by literal asterisks\*
复制代码

效果为：

代码

若是要标记一小段行内代码，你能够用反引号把它包起来（`），例如：

效果图：

若是要在代码区段内插入反引号，你能够用多个反引号来开启和结束代码区段：

效果为：

代码区段的起始和结束端均可以放入一个空白，起始端后面一个，结束端前面一个，这样你就能够在区段的一开始就插入反引号：

效果图：

在代码区段内，& 和方括号都会被自动地转成 HTML 实体，这使得插入 HTML 原始码变得很容易，Markdown 会把下面这段：

效果图：

图片

很明显地，要在纯文字应用中设计一个「天然」的语法来插入图片是有必定难度的。

Markdown 使用一种和连接很类似的语法来标记图片，一样也容许两种样式： 行内式和参考式。

效果：

详细叙述以下：

• 一个惊叹号 !
• 接着一个方括号，里面放上图片的替代文字
• 接着一个普通括号，里面放上图片的网址，最后还能够用引号包住并加上 选择性的 'title' 文字。

详细叙述以下：

一个惊叹号 ! 接着一个方括号，里面放上图片的替代文字 接着一个普通括号，里面放上图片的网址，最后还能够用引号包住并加上 选择性的 'title' 文字。

参考式的图片语法则长得像这样：

其它

自动连接

Markdown 支持以比较简短的自动连接形式来处理网址和电子邮件信箱，只要是用方括号包起来， Markdown 就会自动把它转成连接。通常网址的连接文字就和连接地址同样，例如：

效果：

邮址的自动连接也很相似，只是 Markdown 会先作一个编码转换的过程，把文字字符转成 16 进位码的 HTML 实体，这样的格式能够糊弄一些很差的邮址收集机器人，例如：

效果：

在浏览器里面，这段字串（实际上是 <a href="mailto:address@example.com">address@example.com</a>）会变成一个能够点击的「address@example.com」连接。

（这种做法虽然能够糊弄很多的机器人，但并不能所有挡下来，不过总比什么都不作好些。无论怎样，公开你的信箱终究会引来广告信件的。）

反斜杠

Markdown 能够利用反斜杠来插入一些在语法中有其它意义的符号，例如：若是你想要用星号加在文字旁边的方式来作出强调效果（但不用 < em> 标签），你能够在星号的前面加上反斜杠：

关注技术公众号"程序员驿站"，微信搜索“程序员驿站”，或者微信扫一扫下方二维码便可关注：