MDUtil

Markdown 引用

在行首写 > 就能引用这一行:> 引用的文字。本文介绍多段落引用、嵌套引用、引用里的其他格式,以及部分应用增加的引用类型。

简短回答

Markdown 怎么写引用?

在行首写 > 和一个空格:> 引用的文字,生成 HTML 的 <blockquote> 元素,通常显示为左侧带竖线的缩进块。引用的每一行都以 > 开头,段落之间的空行也要写 >。

Markdown
> 小步提交,频繁发布。
> 每次改动都更容易审查。

显示效果

小步提交,频繁发布。 每次改动都更容易审查。

引用的写法和示例

引用里可以放文档里的任何内容:段落、列表、代码,甚至另一段引用。

多个段落

段落之间的空行写一个单独的 >,几个段落就会留在同一段引用里。

Markdown
> 引用的第一段。
>
> 第二段,仍然在引用里。

显示效果

引用的第一段。

第二段,仍然在引用里。

嵌套引用

每多一个 > 就深一层,和邮件回复的样子一样。

Markdown
> 周五能发布吗?
>
>> 测试通过就可以。
>>
>>> 已经通过了。

显示效果

周五能发布吗?

测试通过就可以。

已经通过了。

引用里的其他格式

标题、列表、加粗和代码都可以写在引用里。

Markdown
> ### 更新说明
>
> - 启动**更快**
> - 新增 `--quiet` 参数

显示效果

更新说明
  • 启动更快
  • 新增 --quiet 参数

结束引用

紧跟在引用后面、没有 > 的一行仍然属于引用。要结束引用,先空一行。

Markdown
> 这一行在引用里
这一行也在。

这一段不在引用里。

显示效果

这一行在引用里 这一行也在。

这一段不在引用里。

GitHub 提示框

引用的第一行是 [!NOTE]、[!TIP]、[!IMPORTANT]、[!WARNING] 或 [!CAUTION] 时,GitHub 会显示成带图标的彩色提示框,其他渲染器显示为普通引用。

Markdown
> [!NOTE]
> 读者应该了解的信息。

> [!WARNING]
> 需要立即注意的信息。

仅适用于 GitHub。其他 Markdown 应用的显示效果不同,因此不提供预览。

Obsidian 标注框

Obsidian 支持任意类型名和可选标题,类型后面加 - 会默认折叠。

Markdown
> [!tip] 快捷键
> 按 Ctrl+P 打开命令面板。

> [!faq]- 标注框能折叠吗?
> 能,这一个默认是折叠的。

仅适用于 Obsidian。其他 Markdown 应用的显示效果不同,因此不提供预览。

各平台的引用支持

> 引用几乎处处可用,聊天软件和 Notion 有自己的规则。

应用支持情况说明
GitHub / GitLab支持文件、Issue 和评论里都能用,GitHub 另有 > [!NOTE] 等提示框。
Discord有差异> 引用一行,>>> 引用消息里后面的全部内容。
Slack支持行首写 > 就是引用。
Obsidian支持支持引用,> [!note] 是标注框。
Notion有差异输入 " 加空格是引用,> 加空格会变成折叠列表。
Typora支持支持引用和嵌套引用。

常见问题

多行引用怎么写?

每一行都以 > 开头。有多个段落时,段落之间的空行写一个单独的 >,引用就不会中断。

怎样结束引用?

在引用后面空一行。紧跟在引用下面、没有 > 的一行仍然算在引用里。

引用可以嵌套吗?

可以,每层多加一个 >:>> 是引用里的引用。

怎样注明引用的出处?

Markdown 没有专门的出处语法。在引用里单独写一行,例如 > —— 鲁迅;允许 HTML 的地方也可以用 <cite> 标签。

GitHub 提示框是什么?

第一行是 [!NOTE]、[!TIP]、[!IMPORTANT]、[!WARNING] 或 [!CAUTION] 的引用。GitHub 会显示成带图标的彩色提示框,其他渲染器显示为普通引用。

Discord 里怎么引用?

输入 > 和空格引用一行,输入 >>> 和空格引用消息里后面的全部内容。

Obsidian 的标注框怎么写?

在引用开头写方括号里的类型,例如 > [!tip] 标题。类型后面加 -,例如 > [!tip]-,标注框会默认折叠。

列表里怎么放引用?

把 > 缩进到和列表项文字对齐:先写 - 列表项,下一行写 > 引用的文字。