跳到主要内容

引用与分隔线

引用和分隔线是文档结构化的重要元素。引用用于突出显示引述内容,分隔线用于划分文档区域。

引用块

引用块用于引用外部内容或突出显示重要信息。

基本语法

在行首使用 > 符号创建引用块:

> 这是一段引用文字。

渲染效果:

这是一段引用文字。

多行引用

引用块可以包含多行文字,每行都以 > 开头:

> 这是引用的第一行。
> 这是引用的第二行。
> 这是引用的第三行。

渲染效果:

这是引用的第一行。 这是引用的第二行。 这是引用的第三行。

也可以只在第一行使用 >,后续行自动包含在引用中:

> 这是引用的第一行。
这是引用的第二行。
这是引用的第三行。

为了可读性,推荐每行都添加 > 符号。

嵌套引用

引用可以嵌套,使用多个 > 符号:

> 第一层引用
>
> > 第二层引用
> >
> > > 第三层引用

渲染效果:

第一层引用

第二层引用

第三层引用

引用中的其他元素

引用块内可以包含其他 Markdown 元素:

标题:

> ## 引用中的标题
>
> 这是标题下的内容。

列表:

> 引用中的列表:
>
> 1. 第一项
> 2. 第二项
> 3. 第三项

代码块:

> 引用中的代码:
>
> ```python
> print("Hello, World!")
> ```

渲染效果:

引用中的列表:

  1. 第一项
  2. 第二项
  3. 第三项

引用的实际应用

引用名人名言:

> 代码是写给人看的,顺便能在机器上运行。
>
> — Donald Knuth

突出重要提示:

> **注意**:此操作不可撤销,请谨慎执行。

引用文档内容:

根据官方文档:

> CommonMark 是一个强定义、高度兼容的 Markdown 规范。

分隔线

分隔线用于在文档中创建视觉分隔,将内容划分为不同区域。

基本语法

使用三个或更多的星号、减号或下划线创建分隔线:

***

---

___

三种符号渲染效果相同:


语法规则

分隔线的语法规则:

  • 至少需要三个相同符号
  • 符号之间可以有空格
  • 符号前后需要空行

以下写法都是有效的:

***
* * *
* * * *
---
- - -
___
_ _ _

注意事项

避免与标题混淆:

减号语法与二级标题的替代语法相似,需要通过上下文区分:

这是二级标题
------------ ← 这是二级标题

这是普通段落

--- ← 这是分隔线

前后空行:

分隔线前后应该有空行,否则可能影响前后内容的渲染:

段落内容

---

另一段内容

分隔线的应用场景

章节分隔:

## 第一章

第一章内容...

---

## 第二章

第二章内容...

主题切换:

## 理论部分

理论内容...

---

## 实践部分

实践内容...

附录分隔:

正文内容...

---

## 附录

附录内容...

GFM 警告框

GitHub Flavored Markdown 扩展了引用语法,支持警告框(Alerts)。

语法格式

> [!NOTE]
> 这是一条提示信息。

> [!TIP]
> 这是一条建议信息。

> [!IMPORTANT]
> 这是一条重要信息。

> [!WARNING]
> 这是一条警告信息。

> [!CAUTION]
> 这是一条注意信息。

渲染效果

[!NOTE] 这是一条提示信息。

[!TIP] 这是一条建议信息。

[!IMPORTANT] 这是一条重要信息。

[!WARNING] 这是一条警告信息。

[!CAUTION] 这是一条注意信息。

使用场景

  • NOTE:提供补充说明
  • TIP:提供实用建议
  • IMPORTANT:强调关键信息
  • WARNING:提醒潜在问题
  • CAUTION:警告可能的负面后果

组合使用

引用和分隔线可以组合使用,创建结构清晰的文档:

## 概述

项目概述内容...

---

## 详细说明

> **重要提示**:请仔细阅读以下内容。

详细说明内容...

---

## 参考资料

> 参考资料 1
> 参考资料 2

最佳实践

引用块

  • 不要过度使用嵌套引用,影响可读性
  • 引用内容应注明出处
  • 使用引用突出重要信息,而非滥用

分隔线

  • 分隔线前后保持空行
  • 同一文档中分隔线使用保持一致
  • 不要滥用分隔线,适当使用章节标题更好

警告框

  • 每篇文章限制警告框数量,避免信息过载
  • 选择正确的警告类型
  • 警告框内容应简洁明了

小结

本章学习了引用和分隔线的使用方法:

  1. 引用块:使用 > 创建,支持嵌套和内部元素
  2. 分隔线:使用 ***---___ 创建
  3. GFM 警告框:五种类型的提示框
  4. 最佳实践:适度使用,保持文档清晰

练习

  1. 创建一个包含嵌套引用的文档
  2. 在引用块中包含列表和代码块
  3. 使用分隔线划分文档章节
  4. 创建不同类型的警告框