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?

去反馈
站长的博客
提个建议