EasyDebug.NET

Markdown 語法速查表

行內樣式、標題、列表、表格、代碼到平臺擴充,含渲染效果說明

共 63 條語法

**加粗**基礎行內語法

渲染为加粗文字

加粗,用兩個星號或兩個下劃線

*斜体*基礎行內語法

渲染为斜体文字

斜體,用一個星號或一個下劃線

***粗斜体***基礎行內語法

渲染为加粗且斜体

同時加粗與斜體

~~删除线~~基礎行內語法

文字中间加一条删除线

刪除線(GFM 擴展,CommonMark 原生不支持)

`行内代码`基礎行內語法

灰底等宽文字

行內代碼,用一個反引號包裹

**粗体里含*斜体***基礎行內語法

嵌套行内样式

行內樣式可以嵌套,但改用下劃線寫法更不容易出錯

注意: 星號嵌套時邊界的空格會讓語法失效,例如 ** 粗 ** 不會生效

---基礎行內語法

一条水平分割线

分割線,三個或更多減號(也可用星號或下劃線)

注意: ⚠️ 減號寫在文字正下方會被當成二級標題的 Setext 寫法,好在前一行要空一行

\*基礎行內語法

显示为字面星号

反斜槓轉義,把後面那個字符當作普通文本

注意: 能轉義的符號是固定的那十幾個 ASCII 標點,轉義其他字符反斜槓會原樣顯示

行尾两个空格基礎行內語法

强制换行,不产生新段落

行尾加兩個空格強制換行

注意: 空格在編輯器裡看不見,容易在格式化時被刪掉;更穩的是寫行尾反斜槓

行尾反斜杠基礎行內語法

强制换行,效果同上但可见

行尾寫反斜槓強制換行,比兩個空格更明顯

 基礎行內語法

插入一个不折行空格

直接寫 HTML 實體,Markdown 會原樣保留

<!-- 注释 -->基礎行內語法

渲染后不显示

註釋,預覽與渲染結果裡都不會出現

# 一级标题標題

最大的标题

一到六級標題,井號後必須有空格

注意: #標題 不寫空格在多數解析器裡不生效(部分平臺做了兼容)

###### 六级标题標題

最小的标题

六級標題,超過六個井號會顯示原文

标题 ===標題

上一行变成一级标题

Setext 寫法,用等號把上一行變成一級標題

标题 ---標題

上一行变成二级标题

Setext 寫法,用減號把上一行變成二級標題

{#custom-id}標題

给标题指定锚点 id

自定義錨點 id(不是標準 Markdown,GitHub 與常見站點另有自動生成規則)

注意: GitHub 的錨點是標題轉小寫加連字符,非 ASCII 會被丟掉,中文標題的錨點通常不可用

1. 有序项列表

带序号的一项

有序列表,數字後跟點與空格

1) 有序项列表

带序号的一项

有序列表的另一種寫法,部分解析器不支持

- 一级 - 二级列表

缩进的子列表

嵌套列表,子項縮進兩到四個空格

注意: 子項縮進不足會被當成同級項,縮進過多會變成代碼塊

- [ ] 待办列表

带空复选框的一项

任務列表未完成態(GFM 擴展)

- [x] 已完成列表

带勾选复选框的一项

任務列表已完成態,x 不區分大小寫

- 列表项 第二段列表

同一项里的第二个段落

列表項裡的多段內容,續段要與項內容對齊

- 列表项 ```js code ```列表

列表项里的代码块

列表項裡放圍欄代碼塊,需按列表寬度縮進

3. 从三开始列表

序号从三开始且后续递增

有序列表的起始數字會生效,但後續序號由解析器遞增

| 列 A | 列 B |表格

表头行

表格第一行是表頭

| --- | --- |表格

分隔行,必须有

分隔行,表頭下方必須有它,否則不渲染成表格

注意: 分隔行的豎線數量要與表頭一致,列數對不上會被截斷

| :--- | ---: |表格

左对齐与右对齐

冒號位置決定對齊:左側左對齊、右側右對齊

| :---: |表格

居中对齐

兩端都寫冒號就是居中

\|表格

显示为竖线字符

單元格里要顯示豎線必須轉義

<br>表格

单元格内换行

單元格里換行用 HTML 的 br,Markdown 的換行語法在表格裡失效

```js代碼

带语法高亮的代码块

圍欄代碼塊,標記語言名可開啓高亮

注意: 大多數實現省略語言名時不會高亮,寫 text 或 txt 可以避免猜錯

~~~代碼

波浪号围栏代码块

用波浪號作圍欄,適合代碼塊裡本身就含反引號的情況

缩进四空格代碼

缩进式代码块

舊式代碼塊寫法,圍欄寫法更好控制

`` `code` ``代碼

内层含反引号的行内代码

內容含反引號時,用更多反引號包裹

[文本](https://example.com)鏈接與圖片

一个超链接

行內式鏈接

[文本](https://example.com "标题")鏈接與圖片

带悬停标题的链接

鏈接可以附帶標題,鼠標懸停時顯示

<https://example.com>鏈接與圖片

自动识别为链接

尖括號包住 URL,自動成為鏈接

[文本][ref] [ref]: https://example.com鏈接與圖片

引用式链接

引用式鏈接,把長 URL 集中放在文末

![替代文字](image.png)鏈接與圖片

一张图片

圖片語法與鏈接只差一個感嘆號

注意: 替代文字不能省:圖片加載失敗時它是唯一線索,也是無障礙讀屏的內容

[![图片](img.png)](https://example.com)鏈接與圖片

点击图片跳转

圖片套鏈接,點擊圖片跳轉

[标题](#自定义锚点)鏈接與圖片

跳到页内某处

頁內跳轉,錨點規則由渲染器決定

[文本](./docs/other.md)鏈接與圖片

跳到相对路径文件

相對路徑鏈接,只在支持文件跳轉的平臺上可點

\[不是链接\]鏈接與圖片

显示为字面方括号

鏈接文本里出現方括號時需要轉義

> 引用内容引用

左侧带竖线的段落

塊引用,大於號後建議留一個空格

>> 嵌套引用引用

两级缩进的引用

嵌套引用,每層加一個大於號

> > 第二段引用

引用里的第二个段落

引用裡的空行也要帶大於號,否則引用被切斷

> ```js > code > ```引用

引用里的代码块

引用裡放代碼塊,每一行都要帶大於號

> **注意**:内容引用

带强调的提示块

引用裡可以再放強調與其他行內語法

> [!NOTE]平臺擴充

带图标的提示块

GitHub 風格的提示塊,另有 TIP / IMPORTANT / WARNING / CAUTION

注意: 只在 GitHub 與其衍生平臺上生效,其他地方會退化成普通引用

[^1]平臺擴充

脚注标记

腳註引用,正文裡寫標記,文末寫定義

[^1]: 脚注内容平臺擴充

脚注定义

腳註定義,名字可以是任意標識符

:smile:平臺擴充

渲染为一个表情

表情短代碼,依賴平臺的表情表

$E = mc^2$平臺擴充

行内数学公式

行內數學公式,依賴 MathJax 或 KaTeX

注意: 絕大多數平臺默認不開數學渲染,會原樣顯示美元符號

$$ E = mc^2 $$平臺擴充

独立成行的公式

塊級數學公式,同樣依賴渲染器

```mermaid平臺擴充

渲染成图表

Mermaid 圖表,平臺需要內置支持

[[_TOC_]]平臺擴充

渲染为目录

自動目錄,GitLab 與部分維基平臺支持

注意: GitHub 不支持,會原樣顯示成文本

#123 / @user平臺擴充

渲染为可点击的引用

議題引用與用戶提及,屬平臺特性而非 Markdown 標準

<br>HTML 混排

强制换行

Markdown 裡可直接寫 HTML,多數平臺允許

<details><summary>标题</summary>内容</details>HTML 混排

可折叠区块

摺疊區塊,常用於放長日誌

注意: GitHub 會渲染它但不會解析塊內的 Markdown(中間要空一行才解析)

<img src="a.png" width="200">HTML 混排

指定宽度的图片

HTML 圖片可以帶屬性,控制尺寸最常用

<kbd>Ctrl</kbd>HTML 混排

键帽样式

鍵盤按鍵樣式,寫文檔時常用

Markdown 里的**粗体**与 <b>粗体</b>HTML 混排

两种粗体写法都生效

行內 HTML 與 Markdown 可以混用

注意: HTML 塊級標籤前後必須空行,否則 Markdown 不再解析其中內容

這個工具不好用,或者遇到 bug?

去回報
站長的博客
提個建議