Markdown语法

声明：本文参考https://www.appinn.com/markdown/，非原创，删除原文部分不经常使用功能，精简文字，为本身参考笔记，修改原文章部分错别字，若是有错漏，欢迎联系我，请多多指教！

概述

宗旨

Markdown的目标是实现易读易写

• 可读性：以纯文本发布，不会像是由不少标签或是格式指令所构成
• 易编辑：语法由一些精挑细选的符号组成，其做用一目了然

兼容HTML

Markdown的语法目标是：成为一种适用网络的书写语言

• HTML是一种发布格式，Markdown是一种书写格式
• Markdown语法种类不多，只对应HTML标记的一小部分
• Markdown的格式语法只涵盖纯文本能够涵盖的范围
• 不在Markdown涵盖范围以内的标签，能够直接在文档里面用HTML撰写
• 在HTML区块标签间的Markdown语法将不会被处理。HTML区块便签必须在先后加上空行与其余内容区隔开，而且在开始与结束标签不能用制表符或空格来缩进
• 在HTML的区段（行内标签）间Markdown 语法是有效的，依照我的习惯，能够直接采用HTML标签来格式化，而不用Markdown提供的连接或者图像便签语法

特殊字符自动转换

• 在HTML文件中，有两个字符须要特殊处理：< 和& 。<符号用于起始便签，&符号用于标记HTML实体，若是想要显示原型，要写成<和&

在HTML文件连接标签在href属性里，若是你要连接到:

你必须把网址转换成

• Markdown会自动将< 和&转化为<和&；若是要在文档中插入一个版权符号©，能够写成©
• 在code范围内，不管是行内和区块，<和&两个符号都必定会被转化成HTML实体，这项特性让你能够很容易地用Markdown写HTML code

区块元素

段落和换行

• 一个Markdown段落是由一个或多个连续的文本行组成，先后默认各有一个空行,若是想要须要自定义插入空行，在插入初先按两个以上的空格而后回车

标题

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

• 类Setext利用 = (最高阶标题)和 - (第二阶阶标题)，任何数量的 = 和 - 均可以有效果，例如：

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

能够选择性地「闭合」类 atx 样式的标题

区块引用Blockquotes

• 在 Markdown 文件中创建一个区块引用,在每行的最前面加上 > ：

• Markdown 也容许你偷懒只在整个段落的第一行最前面加上 > ：

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

• 引用的区块内也可使用其余的 Markdown 语法，包括标题、列表、代码区块等：

列表

Markdown支持有序列表和无序列表

• 有序列表（使用*、+、-做为列表标记）

• 无序列表（使用数字接着一个英文句点）

上面列表使用的数字并不会影响输出的HTML结果，上面的列表所产生的HTML标记为：

注意：

• 有序列表数字不会影响输出结果，但建议最好按照数字顺序来，不只是可读性和美观，更由于Markdown将来可能支持有序列表的start属性。
• 列表项目标记一般是放在最左边，最多能够缩进3个空格，项目标记后面则必定要接着至少一个空格或制表符
• 要让列表看起来更漂亮，最好把内容用固定的缩进整理好，若是你懒，那也行
• 若是列表项目间用空行分开，在输出HTML时Markdown就会自动将项目内容用<p>标签包起来
• 列表项目能够包含多个段落，每一个项目下的段落都必须缩进 4 个空格或是 1 个制表符，每行都缩进会美观好多，若是你懒惰，也容许不缩进，可是段落第一行必须缩进
• 若是要在列表项目内放进引用，那 > 就须要缩进：

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

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

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

代码区块

在 Markdown 中创建代码区块，只要缩进 4 个空格或是 1 个制表符

Markdown 会转换成：

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

使用 Markdown 插入范例用的 HTML 原始码

会被转换为：

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

分隔线

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

区段元素

行内式连接

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

会产生：

参考式连接

在连接文字的括号后面再接上另外一个方括号，而在第二个方括号里面要填入用以辨识连接的标记：（能够选择性地在两个方括号中间加上一个空格）

接着，在文件的任意处，你能够把这个标记的连接内容定义出来：

连接内容定义的形式为：

• 方括号（前面能够选择性地加上至多三个空格来缩进），里面输入连接文字
• 接着一个冒号
• 接着一个以上的空格或制表符
• 接着连接的网址
• 选择性地接着 title 内容，能够用单引号、双引号或是括弧包着

下面这三种连接的定义都是相同：

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

强调

Markdown使用星号（*）和底线（_）做为标记强调字词的符号

• 被 * 或 _ 包围的字词会被转成用 <em> 标签包围
• 用两个 * 或 _ 包起来的话，则会被转成 <strong>

会转成：

若是你的 * 和 _ 两边都有空白的话，它们就只会被当成普通的符号
若是要在文字先后直接插入普通的星号或底线，你能够用反斜线：
<pre>*this text is surrounded by literal asterisks*
</pre>

代码

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

会产生：

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

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

图片

行内式

详细叙述以下：

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

参考式

「id」是图片参考的名称，图片参考的定义方式则和连接参考同样

其余

自动连接

用方括号包起来， Markdown 就会自动把它转成连接

Markdown 会转成：

反斜杠

Markdown 支持如下这些符号前面加上反斜杠来帮助插入普通的符号：