MD 标准语法备查表

MD 标准语法备查表

Markdown 标题

要创建标题,请在单词或短语前面添加井号 (#) 。# 的数量代表了标题的级别。例如,添加三个 # 表示创建一个三级标题 (<h3>) (例如:### My Header)。

Markdown 语法 HTML
# Heading level 1 <h1>Heading level 1</h1>
## Heading level 2 <h2>Heading level 2</h2>
### Heading level 3 <h3>Heading level 3</h3>
#### Heading level 4 <h4>Heading level 4</h4>
##### Heading level 5 <h5>Heading level 5</h5>
###### Heading level 6 <h6>Heading level 6</h6>

可选语法

还可以在文本下方添加任意数量的 == 号来标识一级标题,或者 – 号来标识二级标题。

Markdown 语法 HTML
Heading level 1 =============== <h1>Heading level 1</h1>
Heading level 2 --------------- <h2>Heading level 2</h2>

标题编号

许多 Markdown 处理器支持 标题 的自定义 ID - 一些 Markdown 处理器会自动添加它们。添加自定义 ID 允许您直接链接到标题并使用 CSS 对其进行修改。要添加自定义标题 ID,请在与标题相同的行上用大括号括起该自定义 ID。

1
### My Great Heading {#custom-id}

HTML 看起来像这样:

1
<h3 id="custom-id">My Great Heading</h3>

链接到标题 ID (#headid)

通过创建带有数字符号(#)和自定义标题 ID 的 标准链接,可以链接到文件中具有自定义 ID 的标题。

Markdown HTML
[Heading IDs](#heading-ids) <a href="#heading-ids">Heading IDs</a>

其他网站可以通过将自定义标题 ID 添加到网页的完整 URL(例如 [Heading IDs](https://markdown.com.cn/extended-syntax/heading-ids.html#headid))来链接到标题。

Markdown 段落

要创建段落,请使用空白行将一行或多行文本进行分隔。

1
2
3
I really like using Markdown.

I think I'll use it to format all of my documents from now on.

Markdown 换行

在一行的末尾添加两个或多个空格,然后按回车键,即可创建一个换行 (<br>)。

1
2
This is the first line.    
And this is the second line

Markdown 强调

通过将文本设置为粗体或斜体来强调其重要性。

语法 预览效果
粗体 **粗体**__粗体__ 粗体
斜体 *斜体*_斜体_ 斜体
粗体 + 斜体 ***粗体+斜体***___粗体+斜体___ 粗体 + 斜体

Markdown 引用

要创建块引用,请在段落前添加一个 > 符号。

1
> Dorothy followed her through many of the beautiful rooms in her castle.

渲染效果如下所示:

Dorothy followed her through many of the beautiful rooms in her castle.

Markdown 列表

有序列表

要创建有序列表,请在每个列表项前添加数字并紧跟一个英文句点。数字不必按数学顺序排列,但是列表应当 以数字 1 起始

1
2
3
4
1. First item
2. Second item
2. Third item
5. Fourth item
1
2
3
4
1. First item
1. Second item
1. Third item
1. Fourth item

预览效果

  1. First item
  2. Second item
  3. Third item
  4. Fourth item

无序列表

要创建无序列表,请在每个列表项前面添加破折号 (-)、星号 (*) 或加号 (+) 。缩进一个或多个列表项可创建嵌套列表。

1
2
3
4
- First item  
- Second item
- Third item
- Fourth item

预览效果

  • First item
  • Second item
  • Third item
  • Fourth item

Markdown 代码

行内代码

要将单词或短语表示为代码,请将其包裹在反引号 (`) 中。

语法 预览效果
行内代码 `行内代码` 行内代码
行内转义代码 ``Use `code` in your Markdown file.`` Use `code` in your Markdown file.

代码块

在代码块之前和之后的行上使用三个反引号(```)或三个波浪号(~~~

1
2
3
4
5
6
7
```
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
```

代码语法高亮

许多 Markdown 处理器都支持受围栏代码块的语法突出显示。使用此功能,您可以为编写代码的任何语言添加颜色突出显示。要添加语法突出显示,请在受防护的代码块之前的反引号旁边指定一种语言。

1
2
3
4
5
6
7
```json
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
```

Markdown 分隔线

要创建分隔线,请在单独一行上使用三个或多个星号 (***)、破折号 (---) 或下划线 (___) ,并且不能包含其他内容。

1
2
3
4
5
***

---

_________________

Markdown 删除线

您可以通过在单词中心放置一条水平线来删除单词。结果看起来像这样。此功能使您可以指示某些单词是一个错误,要从文档中删除。若要删除单词,请在单词前后使用两个波浪号 ~~

1
~~世界是平坦的。~~ 我们现在知道世界是圆的。

呈现的输出如下所示:

世界是平坦的。 我们现在知道世界是圆的。

Markdown 链接

超链接

超链接 Markdown 语法代码:[超链接显示名](超链接地址 "超链接title")

对应的 HTML 代码:<a href="超链接地址" title="超链接title">超链接显示名</a>

1
这是一个链接 [Markdown语法](https://markdown.com.cn "这是可选的链接别名")。

网址和 Email 地址

使用尖括号可以很方便地把 URL 或者 email 地址变成可点击的链接。

1
2
<https://markdown.com.cn>
<fake@example.com>

引用链接

引用样式链接是一种特殊的链接,它使 URL 在 Markdown 中更易于显示和阅读。参考样式链接分为两部分:与文本保持内联的部分以及存储在文件中其他位置的部分,以使文本易于阅读。

链接的第一部分格式

可以在第一组和第二组括号之间包含一个空格。第二组括号中的标签不区分大小写,可以包含字母,数字,空格或标点符号。

1
2
[hobbit-hole][1]
[hobbit-hole] [1]

链接的第二部分格式

  1. 放在括号中的标签,其后紧跟一个冒号和至少一个空格(例如 [1]:)。
  2. 链接的 URL,可以选择将其括在尖括号中。
  3. 链接的可选标题,可以将其括在双引号,单引号或括号中。
1
2
3
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle "引用链接的别名"`
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> "引用链接的别名"`
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle (引用链接的别名)`

脚注

要创建脚注参考,请在方括号([^1])内添加插入符号和标识符。标识符可以是数字或单词,但不能包含空格或制表符。标识符仅将脚注参考与脚注本身相关联 - 在输出中,脚注按顺序编号。

1
2
3
Here's a simple footnote,[^1] and here's a longer one.[^bignote]
[^1]: This is the first footnote.
[^bignote]: Here's one with multiple paragraphs and code.

图片链接

插入图片 Markdown 语法代码:![图片alt](图片链接 "图片title")

对应的 HTML 代码:<img src="图片链接" alt="图片alt" title="图片title">

1
![这是图片](/assets/img/philly-magic-garden.jpg "这是可选的图片别名")

Markdown 转义字符

要显示原本用于格式化 Markdown 文档的字符,请在字符前面添加反斜杠字符 \ 。

1
\* Without the backslash, this would be a bullet in an unordered list.

渲染效果如下:

* Without the backslash, this would be a bullet in an unordered list.

以下列出的字符都可以通过使用反斜杠字符从而达到转义目的:

1
\   `   *   _   { }   [ ]   ( )   #   +   -   .   !   |   

Markdown 内嵌 HTML 标签

行级內联标签

HTML 的行级內联标签如 <span><cite><del> 不受限制,可以在 Markdown 的段落、列表或是标题里任意使用。依照个人习惯,甚至可以不用 Markdown 格式,而采用 HTML 标签来格式化。例如:如果比较喜欢 HTML 的 <a> 或 <img> 标签,可以直接使用这些标签,而不用 Markdown 提供的链接或是图片语法。当你需要更改元素的属性时(例如为文本指定颜色或更改图像的宽度),使用 HTML 标签更方便些。示例:

1
This **word** is bold. This <em>word</em> is italic.

预览效果:This word is bold. This word is italic.

区块标签

出于安全原因,并非所有 Markdown 应用程序都支持在 Markdown 文档中添加 HTML。如有疑问,请查看相应 Markdown 应用程序的手册。某些应用程序只支持 HTML 标签的子集。

对于 HTML 的块级元素 <div><table><pre> 和 <p>,请在其前后使用空行(blank lines)与其它内容进行分隔。尽量不要使用制表符(tabs)或空格(spaces)对 HTML 标签做缩进,否则将影响格式。在 HTML 块级标签内不能使用 Markdown 语法。例如 <p>italic and **bold**</p> 将不起作用。

例如,在 Markdown 文件里加上一段 HTML 表格:

1
2
3
4
5
6
7
8
9
This is a regular paragraph.

<table>
<tr>
<td>Foo</td>
</tr>
</table>

This is another regular paragraph.

Markdown 表格

要添加表,请使用三个或多个连字符(---)创建每列的标题,并使用管道(|)分隔每列。您可以选择在表的任一端添加管道。

1
2
3
4
| Syntax      | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |

单元格宽度可以变化,如下所示。呈现的输出将看起来相同。

1
2
3
4
| Syntax | Description |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |

您可以通过在标题行中的连字符的左侧,右侧或两侧添加冒号(:),将列中的文本对齐到左侧,右侧或中心。

1
2
3
4
| Syntax      | Description | Test Text     |
| :--- | :----: | ---: |
| Header | Title | Here's this |
| Paragraph | Text | And more |

您可以使用表格的 HTML 字符代码(&#124;)在表中显示竖线(|)字符。

Markdown 定义列表

一些 Markdown 处理器允许您创建术语及其对应定义的 _ 定义列表 _。要创建定义列表,请在第一行上键入术语。在下一行,键入一个冒号,后跟一个空格和定义。

1
2
3
4
5
6
First Term
: This is the definition of the first term.

Second Term
: This is one definition of the second term.
: This is another definition of the second term.

Markdown 任务列表

任务列表使您可以创建带有复选框的项目列表。在支持任务列表的 Markdown 应用程序中,复选框将显示在内容旁边。要创建任务列表,请在任务列表项之前添加破折号 - 和方括号 [ ],并在 [ ] 前面加上空格。要选择一个复选框,请在方括号 [x] 之间添加 x 。

1
2
3
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

呈现的输出如下所示:

  • Write the press release
  • Update the website
  • Contact the media

Markdown Emoji 表情

有两种方法可以将表情符号添加到 Markdown 文件中:将表情符号复制并粘贴到 Markdown 格式的文本中,或者键入 emoji shortcodes

复制和粘贴表情符号

可以简单地从 Emojipedia (opens new window) 等来源复制表情符号并将其粘贴到文档中。

Tip: 如果您使用的是静态网站生成器,请确保将 HTML 页面编码为 UTF-8。.

使用表情符号简码

一些 Markdown 应用程序允许您通过键入表情符号简码来插入表情符号。这些以冒号开头和结尾,并包含表情符号的名称。

1
2
3
去露营了! :tent: 很快回来。

真好笑! :joy:

呈现的输出如下所示:

去露营了!⛺很快回来。

真好笑!😂