MDUtil

Markdown 语法速查表

一页列出全部 Markdown 语法,一边是要输入的写法,一边是显示效果。每一行都链接到详细教程,打印出来只需几页纸,可以放在手边随时查。

基础语法

语法Markdown显示效果
标题
# 一级标题
## 二级标题
### 三级标题
一级标题
二级标题
三级标题
加粗
**加粗文字**

加粗文字

斜体
*斜体文字*

斜体文字

引用
> 引用的文字

引用的文字

无序列表
- 第一项
- 第二项
  • 第一项
  • 第二项
有序列表
1. 第一项
2. 第二项
  1. 第一项
  2. 第二项
行内代码
运行 `npm install`

运行 npm install

代码块
```js
console.log("hi");
```
console.log("hi");
链接
[示例网站](https://example.com)
图片
![文档状态](/samples/badge.svg)

文档状态

分隔线
---

换行
第一行\
第二行

第一行
第二行

转义字符
\*不是斜体\*

*不是斜体*

扩展语法

语法Markdown显示效果
表格
| 姓名 | 职位 |
| --- | --- |
| 张三 | 设计 |
姓名职位
张三设计
任务列表
- [x] 已完成
- [ ] 待办
  • 已完成
  • 待办
删除线
~~删除的文字~~

删除的文字

脚注
一个说法。[^1]

[^1]: 出处。

一个说法。1

Footnotes
  1. 出处。 ↩

高亮
<mark>高亮</mark>

高亮

数学公式
$E = mc^2$

E=mc2E = mc^2

借助 HTML 的格式

语法Markdown显示效果
下划线
<ins>下划线</ins>

下划线

注释
<!-- 隐藏的备注 -->

不显示任何内容

文字颜色
$\color{#d1242f}{\text{红色文字}}$

红色文字\color{#d1242f}{\text{红色文字}}

居中对齐
<p align="center">居中的文字</p>

居中的文字

折叠内容
<details>
<summary>点击展开</summary>

折叠的内容

</details>
点击展开

折叠的内容

上标和下标
x<sup>2</sup> 和 H<sub>2</sub>O

x2 和 H2O

常见问题

Markdown 是什么?

一种用符号给纯文本加格式的写法,例如用 # 表示标题、用 ** 表示加粗。源文本本身就好读,应用会把它显示成排好版的页面、文档和消息。

基础语法和扩展语法有什么区别?

基础语法是所有 Markdown 应用都支持的核心写法,现在由 CommonMark 规范定义。扩展语法增加了表格、任务列表、删除线、脚注等,大多来自 GitHub 风格 Markdown,多数应用支持,但并非全部。

GitHub 上的 Markdown 一样吗?

GitHub 使用 GitHub 风格 Markdown:包含全部基础语法,再加上表格、任务列表、删除线、脚注、自动链接、提示框和数学公式。这张速查表前两组的写法在 GitHub 上都能用。

Markdown 里能写 HTML 吗?

大多数渲染器允许内嵌 HTML,下划线、居中和折叠内容都是这样写的。网站会出于安全考虑清理 HTML,例如 GitHub 保留 <ins>、<sup> 和 align,但会去掉 style。

Markdown 文件用什么扩展名?

最常用的是 .md,也可以用 .markdown。它们都是纯文本文件,任何编辑器都能打开。

怎样打印这张速查表或保存成 PDF?

点击表格上方的“打印”按钮,或使用浏览器的打印命令;要得到 PDF,在打印机里选择“另存为 PDF”。打印时会去掉页头、页脚和常见问题。

为什么我的 Markdown 在别的网站上显示不一样?

各个应用支持的扩展语法不同,对 HTML 的处理也不同。本站每篇教程都列出了 GitHub、Discord、Slack、Obsidian 等应用对这种语法的支持情况。

在哪里可以试着写 Markdown?

打开 Markdown 在线编辑器,在左边输入,右边就会显示效果。