Markdown语法简介

Posted 2022-10-23 楚弋川

概述

Markdown 是一个 Web 上使用的文本到html的转换工具，可以通过简单、易读易写的文本格式生成结构化的HTML文档。一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布，并且看起来不会像是由许多标签或是格式指令所构成。

Markdown 并非要取代 HTML，而是以一种简单的书写格式，实现一种更加友好的页面呈现，并且，如果所需的标签不在 Markdown 涵盖范围之内，可以直接在文档里面用 HTML 撰写。但要制约的只有一些 HTML 区块元素――比如 <div>、<table>、<pre>、<p> 等标签，必须在前后加上空行与其它内容区隔开，还要求它们的开始标签与结尾标签不能用制表符或空格来缩进。

另外 Markdown 的生成器有足够智能，不会在 HTML 区块标签外加上不必要的 <p> 标签，且书写时一定要在 Markdown 标签和内容之间加上空格，例如：# 标题

基本标签

段落

一个 Markdown 段落是由一个或多个连续的文本行组成，它的前后要有一个以上的空行（空行的定义是显示上看起来像是空的，便会被视为空行。比方说，若某一行只包含空格和制表符，则该行也会被视为空行）。

如图所示：

换行

Markdown 允许段落内的强迫换行，例如直接插入换行符<br/>，如果你确实想要依赖 Markdown 的格式来换行的话，可以在插入处先按入两个以上的空格或者至少一个 Tab 键，然后回车即可。

如图所示：

缩进

普通段落不该用空格或制表符来缩进，因为用了也无效，可以通过在段落前添加需要的空格编码，已达到显示效果。

• 半角空格   或  

• 全角空格   或  

• 不断行空格   或  

如图所示：

标题

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

• 类 Setext 形式是用底线的形式，利用任意数量的 = （一级标题）和 - （二级标题）

• 类 Atx 形式则是在行首插入 1 到 6 个 # ，对应到标题 一级 到 六级

如图所示：

列表

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

• 无序列表使用星号、加号或是减号作为列表标记

• 有序列表则使用数字接着一个英文句点，如果排序错乱，Markdown 仍会以第一个数字进行排序，所以，第一个项目最好还是从 1. 开始

区块引用

Markdown 标记区块引用是使用类似 email 中用 > 的引用方式。

• 可以自己先将内容断好行，然后在每行的最前面加上在每一行加上 > ，如区块引用1

• 也允许你偷懒只在整个段落的第一行最前面加上 > ，如区块引用2

• 区块引用可以嵌套（例如：引用内的引用），只要根据层次加上不同数量的 > ，如区块引用2，3

如图所示：

代码

• 如果要标记一小段行内代码，你可以用反引号把它包起来，如： `代码`

• 如果要在代码区段内插入反引号，你可以用多个反引号来开启和结束代码区段

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

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

如图所示：

代码区块

在 Markdown 中建立代码区块很简单，只要简单地缩进 4 个空格或是 1 个制表符就可以

如图所示：

超链接

超链接允许两种样式： 行内式和参考式。

行内式的形式为：

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

参考式的形式为：

• 在链接文字的括号后面再接上另一个方括号
• 而在第二个方括号里面要填入用以辨识链接的标记

如图所示：

图片

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

其形式为：

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

如图所示：

表格

Markdown 的表格格式虽然简单，但制作起来是很不容易的。

如图所示：

强调

Markdown 使用星号 * 和底线 _ 作为标记强调字词的符号，被 * 或 _ 包围的字词会被转成用 <em> 标签包围，用两个 * 或 _ 包起来的话，则会被转成 <strong>。但是，如果你的 * 或 _ 两边都有空白的话，它们就只会被当成普通的符号。

如图所示：

分隔线

Markdown 允许在一行中用三个以上的星号、减号、底线来建立一个分隔线，也可以在星号或是减号中间插入空格，但行内不能有其他东西。

如图所示：

其他

反斜杠

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

\\ 反斜线
` 反引号
* 星号
_ 底线
花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 减号
. 英文句点
! 惊叹号

自动链接

Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱，只要是用方括号包起来， Markdown 就会自动把它转成链接
<http://baidu.com/>

如图所示：

特殊字符

在 HTML 文件中，有两个字符需要特殊处理： < 和 & 。 < 符号用于起始标签，& 符号则用于标记 HTML 实体，如果你只是想要显示这些字符的原型，你必须要使用实体的形式 < 和 &。但是 code 范围内，不论是行内还是区块， < 和 & 两个符号都一定会被转换成 HTML 实体

推荐

MarkDown 中文

VSCode 代码编辑器