簡介

Markdown是一種輕量級的標記語言，由John Gruber于2004年創建。它的設計目標是讓人們能夠使用易讀易寫的純文本格式編寫文檔，并且可以通過工具將其轉換為結構化的HTML（超文本標記語言）文檔或其他格式。

中文網

https://www.markdown.cn/

https://markdown.com.cn/

特點

簡潔性：Markdown的語法非常簡單，它僅包含少量的符號來表示文本格式，如標題、列表、鏈接、圖片等。這使得寫作者可以專注于內容本身而非排版細節。

可讀性：即使不經過任何渲染，Markdown文本也易于閱讀，因為它盡量保持了純文本的原貌，避免了復雜的標簽和格式化指令。

多功能性：Markdown 文件通常以.md或.markdown擴展名保存，并且可以在幾乎所有的文本編輯器中打開。此外，許多平臺和應用程序都支持Markdown格式，比如GitHub、GitLab、Stack Overflow等網站，以及一些博客系統和Wiki平臺。

跨平臺兼容性：由于Markdown文件本質上是純文本文件，因此它們與操作系統無關，可以在不同的設備和平臺上輕松共享和協作。

易于版本控制：Markdown文件適合納入版本控制系統，如Git，因為它們是純文本格式，便于追蹤更改歷史。

擴展性：雖然標準的Markdown語法相對固定，但很多Markdown編輯器和處理器提供了額外的功能，例如表格、腳注、定義列表、任務列表、數學公式、Mermaid圖表等高級特性。

輸出多樣性：通過適當的工具，Markdown文檔可以被轉換成多種格式，包括但不限于 HTML、PDF 和 Word 文檔。

語法

標題

使用#來表示標題級別，從一級到六級標題分別對應一個到六個#。

# 一級標題

## 二級標題

### 三級標題

#### 四級標題

##### 五級標題

###### 六級標題

效果

自定義ID標題

Markdown處理器支持標題的自定義ID，要添加自定義標題ID，請在與標題相同的行上用大括號括起該自定義ID。 可以通過url后接#ID方法跳轉至頁面錨點處。

### 自定義標題測試 {#test}

效果

強調

用星號*或下劃線_來包裹文字來表示斜體或粗體。

• 斜體：*斜體文字* 或 _斜體文字_

• 粗體：**粗體文字** 或 __粗體文字__

• 粗斜體：***粗斜體文字*** 或 ___粗斜體文字___

效果

段落

使用空白行將一行或多行文本進行分隔

段落一

段落二

效果

段落一

段落二

換行

在一行的末尾添加兩個或多個空格，然后按回車鍵,即可創建一個換行

這是直接換行的

效果

效果

這是直接換行的

效果

列表

• 無序列表使用星號*、加號+或減號-；

• 有序列表則使用數字加英文句點.(數字不必按數學順序排列，但是列表應當以數字1起始)

* 項目1

* 項目2

- 子項目1

- 子項目2

+ 項目一

+ 項目二

1. 第一項

1. 第二項

3. 第三項

效果

• 項目1

• 項目2

• 子項目1

• 子項目2

• 項目一

• 項目二

1. 第一項

2. 第二項

3. 第三項

列表中可以嵌套其他元素：段落、引用、代碼塊、圖片等

引用

要創建塊引用，請在段落前添加一個>符號。

> 這是一個引用示例

效果

這是一個引用示例

代碼

• 單行代碼標注使用`

• 多行代碼塊標注使用 ```，可添加對應語言，實現代碼高亮

`test`

```java

System.out.println("代碼塊");

```

效果

短語

System.out.println("代碼塊");

如果代碼標注中需要包含一個或多個反引號，可以在外層使用是多添加一個反引號，內容前后加空格；

短語使用兩個反引號；代碼塊使用四個反引號。

鏈接

• 鏈接文本放在中括號內，鏈接地址放在后面的括號中，鏈接title可選。

• 鏈接也可和強調聯合使用

效果

圖片

圖片和鏈接格式相似，多了一個!前綴

效果

這是一個圖片

分隔線

可以通過三種方式創建分割線：單行連續三個或更多的 *,-, 或者_。

***

---

_________________

效果

刪除線

在要刪除內容前后使用兩個波浪號~~

這是要~~刪除的內容~~

效果

這是要刪除的內容

表格

• 使用三個或多個連字符（---）創建每列的標題，并使用管道（|）分隔每列；

• 可以在標題行中的連字符的左側，右側或兩側添加冒號（:），將列中的文本對齊到左側，右側或中心；

• 可以聯合單行代碼、鏈接使用。

| 第一列 | 第二列     | 第三列  |

| :---  |    :----:  |   ---: |

| 居左1   | 居中1       | 居右1   |

| 這是`代碼`   | 這是`代碼`       | [這是鏈接]()   |

效果

第一列

第二列

第三列

居左1

居中1

居右1

這是代碼

這是代碼

這是鏈接

任務列表

• 創建任務列表，請在任務列表項之前添加破折號-和方括號[ ]，并在[ ]前面加上空格。

• 要選擇一個復選框，請在方括號[x]之間添加 x。

- [ ] 未選中任務

- [x] 選中任務

效果

定義列表

創建定義列表，請在第一行上鍵入術語。在下一行，鍵入一個冒號:，后跟一個空格和定義。

術語名稱

: 這是術語的詳細解釋

效果

表情

• 從相關Emoji表情網站復制粘貼即可

• 也可以使用表情符號簡碼:https://gist.github.com/rxaviers/7360908

:smirk:

效果

轉義字符

• 顯示原本用于格式化Markdown文檔的字符，在字符前面添加反斜杠字符\

• 可以轉義的字符：\，`，*，_，{ }，[ ]，( )，#，+，-，.，!，|

\* 轉義

效果

* 轉義

內嵌HTML

HTML相關標簽也可正常使用：<span>、<cite>、<del>、<a>、<img>、<div>、<table>、<pre>、<p>

數學公式

• 支持LaTeX數學表達式，需要渲染引擎如MathJax支持

• 行內公式：使用$包圍公式。

• 獨立公式：使用$$包圍公式，使公式單獨占據一行。

這是一個行內公式 $E=mc^2$。

$$ E=mc^2 $$

效果

這是一個行內公式 。

Mermaid繪圖

• Mermaid是一種允許用戶以文本方式定義圖表的工具，

• 各圖表具體使用方法見官方文檔：https://mermaid.nodejs.cn

```Mermaid

graph TD;

A-->B;

A-->C;

B-->D;

C-->D;

```

流程圖效果

高亮

高亮單詞，在單詞前后使用兩個等號 ==

這是一個==高亮示例==。

效果

下標

創建下標，在字符前后使用一個波浪號 ~

H~2~O

效果

注意：==一些 Markdown 應用程序在單詞前后使用一個波浪號，不是用于下標，而是用于刪除線==。

上標

創建上標，請在字符前后使用一個插入符號 ^。

X^2^

效果

腳注

• 在方括號（[^1]）內添加插入符號和標識符。標識符可以是數字或單詞，但不能包含空格或制表符。

• 標識符僅將腳注參考與腳注本身相關聯-在輸出中，腳注按順序編號。

• 在括號內使用另一個插入符號和數字添加腳注，并用冒號和文本[^1]: My footnote。

效果

原文來源：https://mp.weixin.qq.com/s/hVBGgq_BesVbn1D1X9zmJg