返回部落格
教學
Markdown 縮排
Markdown 縮排規則
Markdown 清單縮排
巢狀清單

Markdown 縮排:巢狀清單、段落與程式碼

透過巢狀項目符號清單、編號清單、接續段落和圍欄程式碼的範例修正 Markdown 縮排,避免意外產生程式碼區塊。

5 分鐘閱讀Markdown to Word 團隊

要縮排 Markdown 子清單,請將它的標記對齊到父清單項目正文的第一個字元下方。對於 - 父項目,需要兩個空格;對於 1. 父項目,則需要三個空格。縮排控制的是文件結構,因此給普通段落加入空格,與調整 Word 段落的視覺縮排,可能產生完全不同的效果。

先在 Markdown 檢視器中試試這個範例:

- 專案文件
  - 安裝指南
  - 發行說明
- 審閱檢查清單

安裝指南和發行說明應顯示在專案文件項目之下。審閱檢查清單應保持在最外層。

從父清單項目的正文位置開始計算

對於標記後寫一個空格的普通清單項目,請參照以下對齊規則:

父項目開頭正文前的字元數子清單縮排
- 22 個空格
1. 33 個空格
12. 44 個空格
100. 55 個空格

因此,「一律使用兩個空格」這類通用規則並不適用於編號清單。GitHub 的巢狀清單文件展示了如何相對於父項目正文對齊,其中也包含較長數字標記的情況。

1. 準備發行
   - 確認版本號碼。
   - 更新變更記錄。
2. 發佈文件

巢狀標記前有三個空格。如果它們從左邊界開始,就會建立一個獨立清單,而不屬於第一個編號步驟。

使用較舊的 Markdown 處理器時,也請在該處理器中預覽檔案。本文範例針對 CommonMark 風格的剖析和 GitHub Markdown;舊版實作辨識巢狀區塊的方式可能不同。

在清單項目內加入段落

較長的解釋不一定需要單獨的項目符號。留一個空白行,再將新段落對齊到清單項目正文下方:

1. 審閱安裝指南。

   確認新讀者無需開啟內部文件,
   就能完成設定。

2. 核准發行說明。

解釋段落屬於第一步。除非加入明確的換行標記,否則其中的兩行原始碼會連續排版。

省略這三個空格,可能會結束編號清單,將解釋變成普通段落。在某些編輯流程中,這還可能導致後面的清單重新開始編號。

相同模式也適用於項目符號清單:

- 安裝指南

  包含必要條件、設定命令和驗證步驟。
- 發行說明

如果解釋包含多句話,請使用獨立段落。如果它包含多項需要讀者逐一瀏覽的內容,請使用子清單。

在編號步驟內放置程式碼

圍欄程式碼能清楚標示命令範例的邊界。將起始圍欄、內容和結束圍欄都縮排,以確保區塊仍屬於該清單項目:

1. 檢查已安裝的版本。

   ```sh
   node --version
   ```

   將結果記錄在審閱註記中。

2. 執行專案檢查。

這裡,圍欄從 檢查 的第一個字下方開始。圍欄後的段落也採用相同的對齊方式,因此同樣保留在第一步內。

如果下一個編號步驟變成程式碼區塊的一部分,請檢查結束圍欄。如果程式碼出現在清單之外,請檢查圍欄前的空格。關於語言標籤和字面反引號,請參閱程式碼區塊指南

為什麼四個空格會把文字變成程式碼

在文件最外層,空白行之後某行前面的四個空格,可以建立縮排程式碼區塊:

一個普通段落。

    這一行會顯示為程式碼。

這是 Markdown 刻意設計的語法,並不是縮排控制項失靈。CommonMark 縮排程式碼區塊參考文件解釋了縮排和區塊邊界的作用。

如果一個縮排行緊接普通段落文字,其剖析會受到不同的限制,因此加入空格並不是建立段落視覺縮排的可靠方式。在清單內部,所需空格數還取決於包含它的清單項目。

引用內容請使用引用區塊。如果最終報告中的普通正文需要首行縮排,請在 Markdown 中保留普通段落,並在匯出後到 Word 中設定段落格式。這樣的選擇能保留內容原本的含義。

排查問題時優先使用空格

定位字元可以占據多個顯示欄,而且不同編輯器顯示的寬度可能不同。如果原始碼中的清單看似對齊,轉譯結果卻不正確,請在編輯器中顯示空白字元,並將行首定位字元替換為所需數量的空格。

不要不加區分地替換程式碼範例內的定位字元。那裡的空白可能就是範例本身的一部分。只清理決定外層清單結構的 Markdown 標記和接續內容的縮排。

避免使用重複的不換行空格實體來模仿巢狀清單。這可能讓文字在某個預覽中看起來向右移了,但底層文件仍然只是互不關聯的段落。

匯出 Word 前驗證結構

檢查一個具有代表性的章節,其中包含父清單項目、子清單、第二個段落和圍欄程式碼區塊。在 Markdown 轉 HTML 轉換器中,真正的巢狀清單應包含在它的父清單項目內;僅有視覺偏移並不能建立這種關係。

然後使用 Markdown 轉 Word 轉換器並開啟 DOCX。檢查編號是否按預期接續,以及命令是否仍然屬於相應步驟。Word 的清單樣式可能採用與瀏覽器不同的視覺間距,因此在分享之前,應同時檢查階層結構和最終文件的外觀。

相關文章