Skip to content

高亮

高亮是 Markdown 的一种扩展语法,用于突出显示文档中的重要文本。它帮助读者快速识别关键信息,使文档更加生动有效。

基本语法

标记高亮

在大多数支持高亮的 Markdown 扩展中,高亮文本使用两个等号(==)将要高亮的内容包围起来:

markdown
这是一段包含==高亮文本==的示例。

渲染效果

这是一段包含==高亮文本==的示例。

单词和短语高亮

高亮可以应用于单个词语或短语:

markdown
在编程中,==变量== 是存储数据的命名空间。

请确保阅读文档中的==重要提示和警告==。

渲染效果

在编程中,==变量== 是存储数据的命名空间。

请确保阅读文档中的==重要提示和警告==。

高级用法

与其他格式结合

高亮可以与其他 Markdown 格式组合使用:

markdown
==**粗体高亮**==

==*斜体高亮*==

==***粗体斜体高亮***==

==`代码高亮`==

==[链接高亮](https://www.markdownlang.com)==

渲染效果

==粗体高亮==

==斜体高亮==

==粗体斜体高亮==

==代码高亮==

==链接高亮==

高亮块级内容

某些 Markdown 实现允许对整个块级内容应用高亮,通常使用自定义容器语法:

::: highlight
这是一个高亮的段落块。

它可以包含多行内容,甚至可以包含列表:
- 项目 1
- 项目 2
- 项目 3
:::

注意:块级高亮的支持情况因 Markdown 处理器而异,上述示例在 VitePress 等支持自定义容器的平台上可用。

兼容性和实现差异

不同平台支持情况

平台/工具高亮支持语法
GitHub Markdown不支持
GitLab Markdown==高亮==
Hugo使用mark标签或 ==高亮==
VitePress==高亮==
Pandoc==高亮==[高亮]{.mark}
Jekyll取决于所用主题和插件
CommonMark不支持

HTML 输出格式

大多数支持高亮的 Markdown 处理器会将高亮文本转换为带有 <mark> 标签或特定 CSS 类的 HTML:

html
<!-- 使用 mark 标签 -->
<p>这是一段包含<mark>高亮文本</mark>的示例。</p>

<!-- 使用自定义类 -->
<p>这是一段包含<span class="highlighted">高亮文本</span>的示例。</p>

替代语法

在不支持高亮语法的平台上,可以使用 HTML 标签作为替代:

markdown
这是一段包含<mark>高亮文本</mark>的示例。

<!-- 或使用自定义样式 -->
这是一段包含<span style="background-color: yellow;">高亮文本</span>的示例。

使用场景

文档重点

高亮适用于强调文档中的重要内容:

markdown
# 安装指南

请在安装前==完整备份您的数据==。系统安装过程将会格式化目标分区。

安装步骤:
1. 下载安装程序
2. 运行安装向导
3. ==选择"自定义安装"选项==
4. 按照屏幕提示完成安装

渲染效果

安装指南

请在安装前==完整备份您的数据==。系统安装过程将会格式化目标分区。

安装步骤:

  1. 下载安装程序
  2. 运行安装向导
  3. ==选择"自定义安装"选项==
  4. 按照屏幕提示完成安装

教学材料

高亮在教学和培训材料中特别有用:

markdown
## Python 变量

在 Python 中,变量赋值使用 `=` 符号:

```python
x = 10  # 将值 10 赋给变量 x

==Python 是动态类型语言,变量类型在赋值时自动确定。==

常见的变量类型包括:

  • 整数 (int)
  • 浮点数 (float)
  • 字符串 (str)
  • 布尔值 (bool)

### 文本比较和修订

高亮可以用于突出显示文档中的更改或差异:

```markdown
## 文档版本比较

### 原始版本
服务器将在每周日凌晨 2:00 进行维护。

### 更新版本
服务器将在每周日凌晨 2:00 进行维护。==维护时长预计为 2 小时。==

渲染效果

文档版本比较

原始版本

服务器将在每周日凌晨 2:00 进行维护。

更新版本

服务器将在每周日凌晨 2:00 进行维护。==维护时长预计为 2 小时。==

引用和注释

高亮可以用于标记引用文本中的重点:

markdown
> "这是一段引述文本,==其中这部分内容特别重要==,需要读者特别注意。"
> 
> — 某知名作者

渲染效果

"这是一段引述文本,==其中这部分内容特别重要==,需要读者特别注意。"

— 某知名作者

样式定制

在支持 CSS 自定义的环境中,可以修改高亮文本的样式:

css
/* 自定义高亮样式 */
mark, .highlighted {
  background-color: #ffeb3b;  /* 黄色背景 */
  color: #000;                /* 黑色文字 */
  padding: 0 3px;            /* 内边距 */
  border-radius: 3px;        /* 圆角 */
}

/* 不同类型的高亮 */
.highlight-warning {
  background-color: #ffcdd2;  /* 红色警告高亮 */
}

.highlight-success {
  background-color: #c8e6c9;  /* 绿色成功高亮 */
}

使用自定义样式:

markdown
这是<mark class="highlight-warning">警告信息</mark>,这是<mark class="highlight-success">成功信息</mark>。

最佳实践

使用建议

markdown
✅ 推荐做法:

1. **适度使用高亮**
   - 仅高亮真正重要的内容
   - 过多高亮会削弱突出效果
   
2. **保持一致性**
   - 在整个文档中使用一致的高亮风格
   - 为不同类型的重点内容使用不同的高亮样式
   
3. **结合上下文**
   - 确保高亮内容与周围文本有逻辑联系
   - 可以添加简短说明解释为何某内容被高亮

❌ 避免做法:

1. 高亮过长的段落或整个章节
2. 在一个页面上过度使用高亮
3. 为不重要的内容添加高亮
4. 使用过多不同颜色或样式的高亮

无障碍性考虑

高亮可能对某些用户造成阅读困难。考虑以下几点:

  1. 确保高亮色彩与背景有足够对比度
  2. 不要仅依赖颜色来传达信息
  3. 考虑为高亮内容添加额外的标记(如图标或标题)
  4. 测试文档在不同阅读模式下的可读性(如深色模式)

常见问题解决

高亮不显示

如果您的高亮没有正确显示:

  1. 检查平台是否支持 == 语法的高亮
  2. 尝试使用 HTML <mark> 标签作为替代
  3. 确保 == 与高亮文本之间没有空格
  4. 检查文档是否引用了正确的 CSS 样式

与其他格式冲突

高亮有时会与其他格式产生冲突:

markdown
<!-- 可能有问题的写法 -->
==**复杂[格式](https://www.markdownlang.com)内容**==

<!-- 更安全的写法 -->
<mark>**复杂[格式](https://www.markdownlang.com)内容**</mark>

块级高亮问题

对于需要高亮整个块的情况,建议使用 HTML 或自定义容器:

markdown
<!-- 使用 HTML -->
<div class="highlighted-block">

# 重要章节

这是一个需要整体高亮的内容块。

</div>

<!-- 或使用自定义容器(在支持的平台上) -->
::: highlight
# 重要章节

这是一个需要整体高亮的内容块。
:::

相关语法

  • 强调 - 文本强调语法(粗体、斜体)
  • 引用 - 块引用语法
  • HTML - 在 Markdown 中使用 HTML

工具和插件

  • markdown-it-mark: 为 markdown-it 添加高亮支持
  • remark-highlight.js: 为代码添加语法高亮
  • gatsby-remark-highlight-code: Gatsby 中的代码高亮插件

总结

高亮是一种有效的扩展语法,可以增强文档的可读性和关键信息的可见度。虽然不是所有 Markdown 处理器都原生支持高亮语法,但通过 HTML 标签和自定义 CSS,我们可以在几乎任何环境中实现相似的效果。合理使用高亮可以帮助读者快速定位文档中的重要内容,提升整体阅读体验。

由 Markdownlang.com 整理创建