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 整理創建