Markdown擴展語法

Markdown擴展語法 #

概述 #

原始 Markdown 設計文檔中概述的 基本語法添加了許多日常所需的元素,但對於某些人來說這還不夠。這就是擴展語法的用武之地。

一些個人和組織通過添加其他元素(如表格、代碼塊、語法高亮、URL 自動鏈接和腳註)來擴展 基本語法。可以通過使用基於 基本Markdown語法構建的輕量級標記語言,或者通過向兼容的 Markdown 處理器添加擴展來啟用這些元素。

可用性 #

並非所有 Markdown 應用程序都支持擴展語法元素。您需要檢查您的應用程序使用的輕量級標記語言是否支持您要使用的擴展語法元素。如果沒有,則仍可以在 Markdown 處理器中啟用擴展。

輕量級標記語言 #

有幾種輕量級標記語言是 Markdown 的超集。它們包括基本語法,並通過添加其他元素(如表格、代碼塊、語法高亮、URL 自動鏈接和腳註)來構建它。許多最流行的 Markdown 應用程序使用以下輕量級標記語言之一:

Markdown處理器 #

有數十種 Markdown處理器可用。其中許多允許您添加啟用擴展語法元素的擴展。有關更多信息,請查看您的處理器的文檔。

表格 #

要添加表格,請使用三個或更多連字符 (—) 創建每列的標題,並使用豎線 (|) 分隔每列。為了兼容性,您還應該在行的任一端添加一個管道。

| 語法      | 描述 |
| ----------- | ----------- |
| Header      | 標題       |
| Paragraph   | 文本        |

渲染輸出結果如下:

語法 描述
Header Title
Paragraph Text

單元格寬度可能會有所不同,如下所示。但渲染輸出得結果顯示確實一樣的。

| 語法 | 描述 |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |
提示: 使用連字符和豎線創建表格可能很乏味。為了加快這個過程,請嘗試使用 Markdown Tables GeneratorAnyWayData Markdown Export。使用圖形界面構建表格,然後將生成的 Markdown 格式文本復製到您的文件中。

對齊方式 #

您可以通過在標題行內連字符的左側、右側或兩側添加冒號 (:) 來將列中的文本向左、向右或居中對齊。

| 語法      | 描述 | 測試文本     |
| :---        |    :----:   |          ---: |
| Header      | Title       | Here's this   |
| Paragraph   | Text        | And more      |

渲染輸出結果如下:

語法 描述 測試文本
Header Title Here』s this
Paragraph Text And more

表格中文本格式 #

您可以設置表格中文本的格式。例如,您可以添加 鏈接代碼(僅支持反引號而不是 代碼塊)和 強調

您不能使用標題、塊引用、列表、水平線、圖像或大多數 HTML 標簽。

提示:您可以使用 HTML 創建 換行符並在表格單元格中添加 列表

在表中轉義豎線字符 #

您可以使用表格的 HTML 字符代碼 (|) 在表格中顯示豎線 (|) 字符。

圍欄代碼塊 #

基本的 Markdown 語法允許您通過用四個空格或 1 個製表符縮進行來創建 代碼塊。如果你覺得這不方便,可以嘗試使用圍欄代碼塊。根據你的 Markdown 處理器或編輯器,你將在代碼塊前後的行上使用三個反引號 (’’’) 或三個波浪號 (~~~)。這樣做的好處是不必縮進任何行。

```
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```

渲染輸出結果如下:

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
提示: 需要在代碼塊內顯示反引號請參閱 轉義反引號以了解如何轉義它們。

語法高亮顯示 #

許多 Markdown 處理器支持圍欄代碼塊的語法高亮顯示。此功能允許您為編寫代碼的任何語言添加顏色突出顯示。要添加語法高亮顯示,請在圍欄代碼塊前面的反引號旁邊指定一種語言。

```json
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```

渲染輸出結果如下:

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

腳註 #

腳註允許您添加註釋和引用,而不會使文檔正文變得混亂。創建腳註時,帶有鏈接的上標數字會顯示在添加腳註引用的位置。讀者可以單擊該鏈接跳轉到頁面底部的腳註內容。

要創建腳註引用,請在方括號 ([^1]) 內添加插入符號和標識符。標識符可以是數字或單詞,但不能包含空格或製表符。標識符僅將腳註引用與腳註本身相關聯 — 在輸出中,腳註按順序編號。

使用另一個插入符號和括號內的數字添加腳註,並帶有冒號和文本 ([^1]: 這是一個腳註)。您不必在文檔末尾放置腳註。您可以將它們放在除列表、塊引用和表格等其他元素之外的任何位置。

這是一個腳註,[^1] 這裏是完整版本.[^bignote]

[^1]: 這是一個腳註

[^bignote]: 下面是一個包含多個段落和代碼的命令。

縮進段落以將其包含在腳註中。

    `{ my code }`

    根據需要添加任意數量的段落。

渲染輸出結果如下:

這是一個腳註,1 這裏是完整版本.2

縮進段落以將其包含在腳註中。

`{ my code }`

根據需要添加任意數量的段落。

標題ID #

許多 Markdown 處理器支持 標題的自定義 ID——一些 Markdown 處理器會自動添加它們。通過添加自定義 ID,您可以直接鏈接到標題並使用 CSS 對其進行修改。要添加自定義標題 ID,請將自定義 ID 括在與標題相同的行上的大括號中。

### 十三經 {#custom-id}

對應的HTML代碼如下:

<h3 id="custom-id">十三經</h3>

鏈接到標題ID #

您可以通過創建帶有數字符號 (#) 的標準 鏈接,後跟自定義標題 ID,從而鏈接到文件中具有自定義 ID 的標題。這些通常稱為錨鏈接

Markdown HTML 輸出樣式
[標題ID](#custom-id) <a href="#custom-id">標題ID</a> 標題ID

其他網站可以通過將自定義標題ID添加到網頁的完整 URL 來鏈接到標題(例如,[標題ID](https://markdown.hk/zh/docs/Extended-Syntax/#標題id)

定義列表 #

某些 Markdown 處理器允許您創建術語及其相應定義的定義列表。要創建定義列表,請在第一行鍵入術語。在下一行中,鍵入一個冒號,後跟一個空格和定義。

第一項
: 第一項的定義

第二項
: 第二項的一個定義
: 第二項的另一個定義

對應的HTML代碼如下:

<dl>
  <dt>第一項</dt>
  <dd>第一項的定義</dd>
  <dt>第二項</dt>
  <dd>第二項的一個定義 </dd>
  <dd>第二項的另一個定義</dd>
</dl>

渲染輸出結果如下:

第一項
第一項的定義
第二項
第二項的一個定義
第二項的另一個定義

刪除線 #

您可以通過在單詞中心放置一條水平線來刪除單詞。結果如下所示。此功能允許您指示某些單詞是錯誤,不應包含在文檔中。要刪除單詞,請在單詞前後使用兩個波浪號(~~)。

~~世界是平的~~,我們現在知道世界是圓的。

輸出結果如下:

世界是平的,我們現在知道世界是圓的。

任務列表 #

任務列表(也稱為清單待辦事項列表)允許您創建帶有復選框的項目列表。在支持任務列表的 Markdown 應用程序中,復選框將顯示在內容旁邊。要創建任務列表,請在任務列表項前面添加短劃線 (-) 和帶空格 ([ ]) 的括號。要選中復選框,請在方括號 ([x]) 之間添加一個 x。

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

輸出結果如下:

Markdown任務清單

表情符號 #

有兩種方法可以將表情符號添加到 Markdown 文件中:將表情符號復製並粘貼到 Markdown 格式的文本中,或鍵入表情符號短代碼

復製和粘貼表情符號 #

在大多數情況下,您可以簡單地從 Emojipedia 等來源復製表情符號並將其粘貼到您的文檔中。許多 Markdown 應用程序會自動以 Markdown 格式的文本顯示表情符號。您從 Markdown 應用程序導出的 HTML 和 PDF 文件應該顯示表情符號。

提示:如果您使用的是靜態站點生成器,請確保將HTML頁面 編碼為 UTF-8

使用Emoji簡碼 #

一些 Markdown 應用程序允許您通過鍵入表情符號短代碼來插入表情符號。這些圖標以冒號開頭和結尾,並包含表情符號的名稱。

去露營了! :tent: 很快就會回來。

這太有趣了! :joy:

輸出結果如下:

去露營了! ⛺ 很快就會回來。

這太有趣了! 😂

註意:您可以使用此表情符號 短代碼列表,但請記住,表情符號短代碼因應用程序而異。有關更多信息,請參閱 Markdown 應用程序的文檔。

高亮 #

這並不常見,但某些 Markdown 處理器允許您突出顯示文本。結果如下所示。要突出顯示單詞,請在單詞前後使用兩個等號 (==)。

念念不忘,必有==回響==。

輸出結果如下:

念念不忘,必有回響

或者,如果您的 Markdown 應用程序支持 HTML,則可以使用 mark HTML 標簽。

念念不忘,必有<mark>回響</mark>。

Subscript #

This isn’t common, but some Markdown processors allow you to use subscript to position one or more characters slightly below the normal line of type. To create a subscript, use one tilde symbol (~) before and after the characters.

下標 #

這並不常用,但某些 Markdown 處理器允許您使用下標將一個或多個字符定位在正常類型行略低於正常行的位置。要創建下標,請在字符前後使用一個波浪號 (~)。

H~2~O

輸出結果如下:

H2O

提示: 在使用之前,請務必在 Markdown 應用程序中對此進行測試。一些 Markdown 應用程序在單詞前後使用一個波浪號,而不是用於下標,而是用於 刪除線

或者,如果您的 Markdown 應用程序支持 HTML,則可以使用 sub HTML 標記。

H<sub>2</sub>O

Superscript #

This isn’t common, but some Markdown processors allow you to use superscript to position one or more characters slightly above the normal line of type. To create a superscript, use one caret symbol (^) before and after the characters.

上標 #

這並不常用,但某些 Markdown 處理器允許你使用上標將一個或多個字符定位在正常類型行的略高於正常行的位置。要創建上標,請在字符前後使用一個插入符號 (^)。

km^3^

輸出結果如下:

km3

或者,如果您的 Markdown 應用程序支持 HTML,則可以使用 sup HTML 標記。

km<sup>3</sup>

自動URL鏈接 #

許多 Markdown 處理器會自動將 URL 轉換為鏈接。這意味著如果你鍵入 http://markdown.hk,即使你沒有 使用括號,你的 Markdown 處理器也會自動將其轉換為鏈接。

http://markdown.hk

輸出結果如下:

http://markdown.hk

禁用自動 URL 鏈接 #

如果您不希望 URL 自動鏈接,您可以通過使用反引號將 URL 表示為 代碼來禁用鏈接。

`http://markdown.hk`

輸出結果如下:

http://markdown.hk


  1. 這是一個腳註 ↩︎

  2. 下面是一個包含多個段落和代碼的命令。 ↩︎