项目

Markdown 基本语法

概览

几乎所有的 Markdown 应用都支持原始 Markdown 设计文档中概述的基本语法。Markdown 处理器之间存在一些微小的差异和不一致之处——只要可能,这些都会在相关位置进行注释说明。

标题

要创建一个标题,只需在单词或短语前添加井号(#)。你使用的井号数量应与标题级别相对应。例如,要创建一个第三级标题(###),需使用三个井号(例如,### 我的标题)。

Markdown HTML 渲染输出
# Heading level 1 <h1>Heading level 1</h1>

Heading level 1

## Heading level 2 <h2>Heading level 2</h2>

Heading level 2

### Heading level 3 <h3>Heading level 3</h3>

Heading level 3

#### Heading level 4 <h4>Heading level 4</h4>

Heading level 4

##### Heading level 5 <h5>Heading level 5</h5>
Heading level 5
###### Heading level 6 <h6>Heading level 6</h6>
Heading level 6

替代语法

或者,在文本下方的行中,为一级标题添加任意数量的 == 字符,为二级标题添加 -- 字符。例如:

Markdown HTML 渲染输出
Heading level 1
===============
<h1>Heading level 1</h1>

Heading level 1

Heading level 2
---------------
<h2>Heading level 2</h2>

Heading level 2

标题最佳实践

Markdown 应用在处理井号(#)与标题名称之间缺失空格的问题上并未达成共识。为了确保兼容性,建议在井号与标题名称之间始终加上空格。

推荐做法 避免这样做
# 这是一个标题 #这是一个标题

同时,出于兼容性的考虑,应在标题前后各放置一个空行。

推荐做法 避免这样做
努力在...

# 标题...

...标题前后放置空行。
如果没有空行,可能看起来就不对了
# 标题
不要这样做!

段落

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

Markdown HTML 渲染输出
我真的很喜欢使用 Markdown。

我认为从现在起我会用它来格式化我所有的文档。
<p>我真的很喜欢使用 Markdown。</p>
<p>我认为从现在起我会用它来格式化我所有的文档。</p>

我真的很喜欢使用 Markdown。

我认为从现在起我会用它来格式化我所有的文档。

段落最佳实践

除非段落位于列表中,否则不要使用空格或制表符缩进段落。

注意:如果需要在输出中缩进段落,请参阅关于如何缩进(使用制表符)的部分。

推荐做法 避免这样做
不要在段落前放置制表符或空格。

保持行左对齐,像这样。

    这可能导致意外的格式问题。

    不要在段落前添加制表符或空格。

换行

要创建换行或新行,需在行尾加上两个或更多的空格,然后按回车键。

Markdown HTML 渲染输出
这是第一行。  
这是第二行。
<p>这是第一行。<br> 这是第二行。</p> 这是第一行。
这是第二行。

最佳实践:换行

在几乎每种 Markdown 应用中,你可以使用两个或以上空格(通常称为“尾随空白”)来进行换行,但这做法颇具争议。在编辑器中很难看到尾随空白,并且许多人可能会在每个句子后意外或故意地加上两个空格。因此,你可能希望使用除尾随空白之外的方法来进行换行。如果你的 Markdown 应用支持 HTML,你可以使用 HTML 的<br>标签来实现换行。

为了保持兼容性,建议在行尾使用尾随空白或 <br> HTML 标签。

还有两种我不推荐的选项。CommonMark 和其他一些轻量级标记语言允许你在行尾输入反斜杠(\),但并非所有 Markdown 应用都支持此功能,因此从兼容性的角度来看,这不是一个好选择。并且至少有几种轻量级标记语言不要求在行尾添加任何内容——只需按下回车,它们就会创建一个换行。

✅ 请这样做 ❌ 请不要这样做
第一行,后面有两个空格。  
接着下一行。

第一行,后面跟有 HTML 标签。<br>
接着下一行。
第一行,后面跟着反斜杠。\
接着下一行。

第一行,后面什么都没有。
接着下一行。

强调

你可以通过加粗或斜体文字来增加强调效果。

粗体

要使文本变为粗体,需在单词或短语前后分别添加两个星号(**)或下划线(__)。如果要强调单词中间的部分,可在字母周围不加空格的情况下添加两个星号。

Markdown HTML 呈现效果
I just love **bold text**. I just love <strong>bold text</strong>. 我就是喜欢粗体文本
I just love **bold text**. I just love <strong>bold text</strong>. 我就是喜欢粗体文本
Love**is**bold Love<strong>is</strong>bold Loveisbold

粗体最佳实践

对于单词中的下划线,不同的 Markdown 应用处理方式不尽相同。为了兼容性,强调单词中间部分时建议使用星号。

✅ 请这样做 ❌ 请不要这样做
Love**is**bold Love__is__bold

斜体

要使文本变为斜体,需在单词或短语前后分别添加一个星号(*)或下划线(_)。如果要强调单词中间的部分,可在字母周围不加空格的情况下添加一个星号。

Markdown HTML 呈现效果
斜体文本是猫的*喵声*. 斜体文本是猫的<em>喵声</em>. 斜体文本是猫的喵声
A*cat*meow A<em>cat</em>meow Acatmeow

斜体最佳实践

对于单词中的下划线,Markdown 应用之间同样存在处理差异。为了兼容性,强调单词中间部分时推荐使用星号。

✅ 请这样做 ❌ 请不要这样做
A*cat*meow A_cat_meow

粗体与斜体

要同时使用粗体和斜体强调文本,请在单词或短语前后分别添加三个星号(***)或下划线(___)。若要同时对单词中间部分进行粗体和斜体强调,请在字母周围不加空格的情况下添加三个星号。

Markdown HTML 呈现效果
这段文本 ***真的非常重要***. 这段文本 <em><strong>真的非常重要</strong></em>. 这段文本真的非常重要
这段文本 ___真的非常重要___. 这段文本 <em><strong>真的非常重要</strong></em>. 这段文本真的非常重要
这段文本 __*真的非常重要*__. 这段文本 <em><strong>真的非常重要</strong></em>. 这段文本真的非常重要
这段文本 **_真的非常重要_**. 这段文本 <em><strong>真的非常重要</strong></em>. 这段文本真的非常重要
这是一段***非常非常***重要的文本. 这是一段<em><strong>非常非常</strong></em>重要的文本. 这是一段非常非常重要的文本。

注意:根据所使用的 Markdown 处理器,<em><strong> 标签的顺序可能会颠倒。

粗体与斜体最佳实践

对于单词中的下划线,不同的 Markdown 应用处理方式不同。为了兼容性,强调单词中间部分时建议使用星号。

✅ 请这样做 ❌ 请不要这样做
This is really***very***important text. This is really___very___important text.

引用块

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

> 多萝西跟着她穿过了城堡中许多美丽的房间。

呈现的效果如下:

多萝西跟着她穿过了城堡中许多美丽的房间。

含有多段落的引用块

引用块可以包含多个段落。在段落之间的空白行前添加一个 >

> 多萝西跟着她穿过了城堡中许多美丽的房间。
>
> 女巫吩咐她清洗锅碗瓢盆、扫地以及不断地往火里添木头。

呈现的效果如下:

多萝西跟着她穿过了城堡中许多美丽的房间。

女巫吩咐她清洗锅碗瓢盆、扫地以及不断地往火里添木头。

嵌套引用块

引用块可以嵌套。在你想要嵌套的段落前添加一个 >>

> 多萝西跟着她穿过了城堡中许多美丽的房间。
>
>> 女巫吩咐她清洗锅碗瓢盆、扫地以及不断地往火里添木头。

呈现的效果如下:

多萝西跟着她穿过了城堡中许多美丽的房间。

女巫吩咐她清洗锅碗瓢盆、扫地以及不断地往火里添木头。

引用块中包含其他元素

引用块可以包含其他 Markdown 格式化的元素。不过并非所有元素都能使用——你需要通过尝试来确定哪些元素是可行的。

> #### 本季度的业绩看起来棒极了!
>
> - 收入创历史新高。
> - 利润高于以往任何时候。
>
> *一切*都按照**计划**进行。

呈现的效果如下:

本季度的业绩看起来棒极了!

  • 收入创历史新高。
  • 利润高于以往任何时候。

一切都按照计划进行。

引用块最佳实践

为了兼容性,请在引用块前后各放置一个空行。

✅ 请这样做 ❌ 请不要这样做
尝试在...之前放入一个空行

> 这是一个引用块

...并在引用块之后也放入一个空行。
如果没有空行,可能看起来就不对了。
> 这是一个引用块
不要这样做!

列表

你可以将项目组织成有序列表和无序列表。

有序列表

要创建有序列表,请添加带有数字和句点的项目行。这些数字不必按数值顺序排列,但列表应以数字 1 开始。

Markdown HTML 呈现效果
1. 第一项
2. 第二项
3. 第三项
4. 第四项
<ol>
    <li>第一项</li>
    <li>第二项</li>
    <li>第三项</li>
    <li>第四项</li>
</ol>
  1. 第一项
  2. 第二项
  3. 第三项
  4. 第四项
1. 第一项
1. 第二项
1. 第三项
1. 第四项
<ol>
    <li>第一项</li>
    <li>第二项</li>
    <li>第三项</li>
    <li>第四项</li>
</ol>
  1. 第一项
  2. 第二项
  3. 第三项
  4. 第四项
1. 第一项
8. 第二项
3. 第三项
5. 第四项
<ol>
    <li>第一项</li>
    <li>第二项</li>
    <li>第三项</li>
    <li>第四项</li>
</ol>
  1. 第一项
  2. 第二项
  3. 第三项
  4. 第四项
1. 第一项
2. 第二项
3. 第三项
    1. 缩进项
    2. 缩进项
4. 第四项
<ol>
    <li>第一项</li>
    <li>第二项</li>
    <li>第三项
        <ol>
            <li>缩进项</li>
            <li>缩进项</li>
        </ol>
    </li>
    <li>第四项</li>
</ol>
  1. 第一项
  2. 第二项
  3. 第三项
    1. 缩进项
    2. 缩进项
  4. 第四项

有序列表最佳实践

CommonMark 和其他一些轻量级标记语言允许你使用括号())作为分隔符(例如,1) 第一项),但并非所有 Markdown 应用都支持此功能,因此从兼容性角度来看,这不是一个好选择。为了兼容性,请仅使用句点。

✅ 请这样做 ❌ 请不要这样做
1. 第一项
2. 第二项
1) 第一项
2) 第二项

无序列表

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

Markdown HTML 呈现效果
- 第一项
- 第二项
- 第三项
- 第四项
<ul>
    <li>第一项</li>
    <li>第二项</li>
    <li>第三项</li>
    <li>第四项</li>
</ul>
  • 第一项
  • 第二项
  • 第三项
  • 第四项
_ 第一项
_ 第二项
_ 第三项
_ 第四项
<ul>
    <li>第一项</li>
    <li>第二项</li>
    <li>第三项</li>
    <li>第四项</li>
</ul>
  • 第一项
  • 第二项
  • 第三项
  • 第四项
+ 第一项
+ 第二项
+ 第三项
+ 第四项
<ul>
    <li>第一项</li>
    <li>第二项</li>
    <li>第三项</li>
    <li>第四项</li>
</ul>
  • 第一项
  • 第二项
  • 第三项
  • 第四项
- 第一项
- 第二项
- 第三项
    - 缩进项
    - 缩进项
- 第四项
<ul>
    <li>第一项</li>
    <li>第二项</li>
    <li>第三项
        <ul>
            <li>缩进项</li>
            <li>缩进项</li>
        </ul>
    </li>
    <li>第四项</li>
</ul>
  • 第一项
  • 第二项
  • 第三项
    • 缩进项
    • 缩进项
  • 第四项

以数字开头的无序列表项

如果你需要以数字加句点开始无序列表项,可以使用反斜杠(\)来转义句点。

Markdown HTML 呈现效果
- 1968. 伟大的一年!
- 我认为 1969 年排第二。
<ul>
<li>1968. 伟大的一年!</li>
<li>我认为 1969 年排第二。</li>
</ul>
  • 1968. 伟大的一年!
  • 我认为 1969 年排第二。

无序列表最佳实践

不同的 Markdown 应用对于同一列表中不同分隔符的处理方式并不一致。为了兼容性,不要在同一列表中混合使用分隔符——选择一种并坚持使用它。

✅ 请这样做 ❌ 请不要这样做
- 第一项
- 第二项
- 第三项
- 第四项
+ 第一项
* 第二项
- 第三项
+ 第四项

在列表中添加元素

为了在保持列表连续性的同时在列表中添加其他元素,如以下示例所示,应对元素进行四个空格或一个制表符的缩进。

提示:如果内容显示不符合预期,请再次检查是否已将列表中的元素缩进了四个空格或一个制表符。

段落

- 这是列表的第一项。
- <p>这是列表的第二项。</p>
  <p>我需要在第二项列表项下方再添加一段话。</p>
- 这是第三项列表项。

呈现的效果如下:

  • 这是列表的第一项。
  • 这是列表的第二项。

    我需要在第二项列表项下方再添加一段话。

  • 这是第三项列表项。

引用块

- 这是列表的第一项。
- 这是列表的第二项。

  > 在第二项列表项下方添加引用块会很棒。

- 这是第三项列表项。

呈现的效果如下:

  • 这是列表的第一项。

  • 这是列表的第二项。

    在第二项列表项下方添加引用块会很棒。

  • 这是第三项列表项。

代码块

代码块通常缩进四个空格或一个制表符。当它们位于列表中时,请缩进八个空格或两个制表符。

1. 打开文件。
2. 查找第 21 行上的以下代码块:

<html>
    <head>
    <title>Test</title>
    </head>

3. 更新标题以匹配您网站的名称。

呈现的效果如下:

  1. 打开文件。
  2. 查找第 21 行上的以下代码块:
<html>
  <head>
    <title>Test</title>
  </head>
</html>
  1. 更新标题以匹配您网站的名称。

图片

1. 打开包含 Linux 吉祥物的文件。
2. 欣赏它的美。
   ![Tux,Linux吉祥物](https://koudingke.oss-cn-hangzhou.aliyuncs.com/docs/md-docs/images/tux.png "")
3. 关闭文件。

呈现的效果如下:

  1. 打开包含 Linux 吉祥物的文件。
  2. 欣赏它的美。
  3. 关闭文件。

列表

你可以在有序列表中嵌套无序列表,反之亦然。

1. 第一项
2. 第二项
3. 第三项
   - 缩进项
   - 缩进项
4. 第四项

呈现的效果如下:

  1. 第一项
  2. 第二项
  3. 第三项
    • 缩进项
    • 缩进项
  4. 第四项

翻译

代码

要将单词或短语标记为代码,请使用反引号(`)将其包围。

Markdown HTML 渲染输出
在命令提示符下,键入 `nano`。 在命令提示符下,键入 <code>nano</code>。 在命令提示符下,键入 nano

转义反引号

如果您想标记为代码的单词或短语包含一个或多个反引号,可以通过将其包围在双反引号(``)中来转义。

Markdown HTML 渲染输出
``在您的 Markdown 文件中使用 `code`。`` <code>在您的 Markdown 文件中使用\'code\'。</code> 在您的 Markdown 文件中使用 code

代码块

水平线

要创建水平线,请在单独的一行上使用三个或更多破折号(---)。

---

水平线的最佳实践

为了兼容性,请在水平线前后放置空行。

✅ 这样做 ❌ 不要这样做
尝试在...之前放置一个空行

---

...以及水平线之后。
如果没有空行,这将是一个标题。
---
不要这样做!

链接

要创建链接,请将链接文本括在方括号中(例如,[鸭鸭搜索]),然后立即跟随圆括号中的 URL(例如,(https://duckduckgo.com))。

我最喜欢的搜索引擎是 [Duck Duck Go](https://duckduckgo.com)。

渲染后的输出如下:

我最喜欢的搜索引擎是 Duck Duck Go

注意:要链接到同一页上的元素,请参见链接到标题 ID。要创建在新标签页或窗口中打开的链接,请参见链接目标部分。

添加标题

您可以选择性地为链接添加标题。当用户将鼠标悬停在链接上时,这将以工具提示的形式出现。要添加标题,请在 URL 后用引号将其括起来。

我最喜欢的搜索引擎是 [Duck Duck Go](https://duckduckgo.com "隐私最佳的搜索引擎")。

渲染后的输出看起来像这样:

我最喜欢的搜索引擎是 Duck Duck Go

URL 和电子邮件地址

要快速将 URL 或电子邮件地址转换为链接,请将其括在尖括号中。

<https://www.markdownguide.org>
<fake@example.com>

渲染后的输出如下所示:

https://www.markdownguide.org

fake@example.com

格式化链接

我非常喜欢支持 **[EFF](https://eff.org)**.
这是 _[Markdown 指南](https://www.markdownguide.org)_.
参见关于 [`code`](#code) 的部分.

渲染后的输出看起来像这样:

我非常喜欢支持 EFF

这是 Markdown 指南

参见关于 代码 的部分。

引用式链接

引用式链接是一种特殊的链接类型,它使 Markdown 中的 URL 更易于显示和阅读。引用式链接由两部分构成:一部分保留在文本内,另一部分存储在文件的其他位置,以保持文本易于阅读。

格式化链接的第一部分

引用式链接的第一部分使用两组方括号进行格式设置。第一组方括号围绕应该显示为链接的文本。第二组方括号显示一个标签,用于指向您在文档其他位置存储的链接。

虽然不是必需的,但您可以在第一组和第二组方括号之间包含一个空格。第二组方括号中的标签不区分大小写,并且可以包含字母、数字、空格或标点符号。

这意味着以下示例格式对于链接的第一部分大致等效:

  • [hobbit-hole][1]
  • [hobbit-hole] [1]

格式化链接的第二部分

引用式链接的第二部分采用以下属性进行格式设置:

  1. 标签,用方括号括起,紧接着是冒号和至少一个空格(例如,[标签]: )。
  2. 链接的 URL,您可以选择性地将其括在尖括号中。
  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]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle (霍比特人的生活方式)
  • [1]: <https: en.wikipedia.org="" wiki="" hobbit#lifestyle=""> "霍比特人的生活方式"</https:>
  • [1]: <https: en.wikipedia.org="" wiki="" hobbit#lifestyle=""> '霍比特人的生活方式'</https:>
  • [1]: <https: en.wikipedia.org="" wiki="" hobbit#lifestyle=""> (霍比特人的生活方式)</https:>

您可以将此链接的第二部分内容放在 Markdown 文档的任何位置。有些人将其紧随其出现的段落后放置,而其他人则将其放在文档末尾(如尾注或脚注)。

组合部分的示例

假设您将 URL 作为标准 URL 链接添加到段落中,在 Markdown 中它看起来像这样:

在地底的一个洞里住着一个霍比特人。这不是一个肮脏、湿漉漉、满是虫尾巴和黏糊糊气味的讨厌洞穴,也不是一个干燥、光秃秃、沙质的洞,里面没有任何东西可以坐下来休息或是用来吃:这里是个 [霍比特人的洞穴](https://en.wikipedia.org/wiki/Hobbit#Lifestyle "霍比特人的生活方式") ,意味着舒适的生活。

尽管显示的 URL 可能指向了有趣的信息,但它除了让原始文本更难以阅读之外,实际上并没有增加太多内容。为了解决这个问题,你可以将 URL 格式化为这样:

在地底的一个洞里住着一个霍比特人。这不是一个肮脏、湿漉漉、满是虫尾巴和黏糊糊气味的讨厌洞穴,也不是一个干燥、光秃秃、沙质的洞,里面没有任何东西可以坐下来休息或是用来吃:这里是个 [霍比特人的洞穴][1],意味着舒适的生活。

[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle "霍比特人的生活方式"

在这两个例子中,渲染后的输出都是相同的:

在地底的一个洞里住着一个霍比特人。这不是一个肮脏、湿漉漉、满是虫子和黏糊糊臭味的恶心洞穴,也不是一个干涸、光秃秃、满是沙子、里面没有任何东西可以坐或吃的东西的洞:这是一个 霍比特人的洞穴,这意味着舒适。

而链接的 HTML 代码将会是:

<a
  href="https://en.wikipedia.org/wiki/Hobbit#Lifestyle"
  title="Hobbit lifestyles"
  >霍比特人的洞穴</a
>

链接最佳实践

Markdown 应用程序在处理 URL 中的空格时存在不一致。为了确保兼容性,尝试使用 %20 对任何空格进行 URL 编码。或者,如果您的 Markdown 应用程序支持 HTML,您可以使用 a HTML 标签。

✅ 这样做 ❌ 不要这样做
[link](https://www.example.com/my%20great%20page)

<a href="https://www.example.com/my great page">link</a>
[link](https://www.example.com/my great page)

URL 中的括号也可能引发问题。为了确保兼容性,尝试使用 %28 对左括号(()进行 URL 编码,并使用 %29 对右括号())进行编码。另外,如果您的 Markdown 应用支持 HTML,您也可以使用 a HTML 标签来规避这个问题。

✅ 这样做 ❌ 不要这样做
[a novel](https://en.wikipedia.org/wiki/The_Milagro_Beanfield_War_%28novel%29)

<a href="https://en.wikipedia.org/wiki/The_Milagro_Beanfield_War_(novel)">a novel</a>
[a novel](https://en.wikipedia.org/wiki/The_Milagro_Beanfield_War_(novel))

图片

要添加图片,请插入一个感叹号(!),后面紧跟括号中的替代文本,以及指向图片资源的路径或 URL。您还可以在路径或 URL 后选择性地添加引号中的标题。

![圣胡安山脉真美!](https://koudingke.oss-cn-hangzhou.aliyuncs.com/docs/md-docs/images/san-juan-mountains.jpg "圣胡安山脉")

渲染后的输出看起来像这样:

圣胡安山脉真美!

注意: 要调整图片大小,请参阅图片尺寸部分。要添加图片说明,请查看图片说明部分。

图片链接

要为图片添加链接,请将图片的 Markdown 语法用方括号包围,然后在圆括号中添加链接。

[![沙漠中的一块古老岩石](https://koudingke.oss-cn-hangzhou.aliyuncs.com/docs/md-docs/images/shiprock.png "新墨西哥州的 Shiprock")](https://www.flickr.com/photos/beaurogers/31833779864/in/photolist-Qv3rFw-34mt9F-a9Cmfy-5Ha3Zi-9msKdv-o3hgjr-hWpUte-4WMsJ1-KUQ8N-deshUb-vssBD-6CQci6-8AFCiD-zsJWT-nNfsgB-dPDwZJ-bn9JGn-5HtSXY-6CUhAL-a4UTXB-ugPum-KUPSo-fBLNm-6CUmpy-4WMsc9-8a7D3T-83KJev-6CQ2bK-nNusHJ-a78rQH-nw3NvT-7aq2qf-8wwBso-3nNceh-ugSKP-4mh4kh-bbeeqH-a7biME-q3PtTf-brFpgb-cg38zw-bXMZc-nJPELD-f58Lmo-bXMYG-bz8AAi-bxNtNT-bXMYi-bXMY6-bXMYv)

渲染结果看起来像这样:

沙漠中的一块古老岩石

转义字符

为了在 Markdown 文档中显示原本用于格式化文本的特殊字符,您需要在该字符前添加反斜杠(\)。

例如: * 没有反斜杠的话,这将会是无序列表中的一个项目符号。

渲染后的输出看起来像这样:

  • 没有反斜杠的话,这将会是无序列表中的一个项目符号。

可以转义的字符

您可以使用反斜杠来转义以下字符。

字符 名称
\ 反斜线
``` 反引号(参见代码中转义反引号)
* 星号
_ 下划线
{} 大括号
[] 方括号
<> 尖括号
() 圆括号
# 井号
+ 加号
- 减号(连字符)
. 点(句点)
! 感叹号(惊叹号)
| 竖线(管道符号,参见表格中转义竖线)

请注意,转义这些字符意味着它们将被当作普通文本显示,而不会触发 Markdown 的特殊格式化效果。

HTML

许多 Markdown 应用允许你在 Markdown 格式的文本中使用 HTML 标签。这对于偏好特定 HTML 标签而非 Markdown 语法的用户非常有用。例如,有些人觉得使用 HTML 标签处理图片更为简单。当需要更改元素的属性时,比如指定文本颜色或改变图片宽度,使用 HTML 也非常有帮助。

要在 Markdown 中使用 HTML,只需将 HTML 标签直接插入到 Markdown 格式文件的文本中即可。

例如:

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

渲染后的输出看起来像这样:

This word is bold. This word is italic.

注意,在这个例子中,虽然**word**是 Markdown 用于加粗的语法,同时<em>word</em>是 HTML 用于斜体的标签,但两者都被正确解析并渲染。Markdown 解析器通常会对嵌入的 HTML 代码保持友好,允许你混合使用 Markdown 和 HTML 来达到期望的格式效果。

HTML 最佳实践

出于安全考虑,并非所有 Markdown 应用程序都支持在 Markdown 文档中使用 HTML。如有疑问,请查阅你的 Markdown 应用程序的文档。一些应用可能只支持 HTML 标签的一个子集。

对于像<div><table><pre><code>等块级 HTML 元素,使用空行将其与周围内容分隔开。尽量不要用制表符或空格来缩进这些标签——这样做可能会干扰格式设置。

在块级 HTML 标签内部不能使用 Markdown 语法。例如,下面的写法不会生效:

<div>*italic* and **bold**</div>
在本文档中