本文档展示了 Markdown 的各种常用语法和格式,既作为语法参考,也展示极简主题的渲染效果。

标题

Markdown 支持 6 级标题:

1
2
3
4
5
6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

注意:标题会自动生成锚点,可以通过 [链接](#标题) 跳转。


段落与换行

段落

段落之间用空行分隔:

1
2
3
这是第一段。

这是第二段。

换行

行末加两个空格或使用 <br>

1
2
第一行  
第二行

文本样式

强调

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
**粗体文本**
__粗体文本__

*斜体文本*
_斜体文本_

***粗斜体***
___粗斜体___

~~删除线~~

效果:

  • 粗体文本
  • 斜体文本
  • 粗斜体
  • 删除线

标记

1
==高亮文本==

效果:

==高亮文本==


列表

无序列表

1
2
3
4
5
- 项目 1
- 项目 2
  - 子项目 2.1
  - 子项目 2.2
- 项目 3

效果:

  • 项目 1
  • 项目 2
    • 子项目 2.1
    • 子项目 2.2
  • 项目 3

有序列表

1
2
3
4
5
1. 第一项
2. 第二项
   1. 子项 2.1
   2. 子项 2.2
3. 第三项

效果:

  1. 第一项
  2. 第二项
    1. 子项 2.1
    2. 子项 2.2
  3. 第三项

任务列表

1
2
3
- [x] 已完成任务
- [ ] 未完成任务
- [ ] 待办事项

效果:

  • 已完成任务
  • 未完成任务
  • 待办事项

链接与图片

链接

1
2
3
4
5
6
7
8
9
[链接文本](https://example.com)

[带标题的链接](https://example.com "链接标题")

[相对路径链接](./01-快速入门.md)

<https://example.com>

<email@example.com>

效果:

图片

1
2
3
![图片替代文本](/path/to/image.jpg)

![带标题的图片](/path/to/image.jpg "图片标题")

效果:

示例图片


引用

基本引用

1
2
> 这是一段引用文本。
> 可以包含多行内容。

效果:

这是一段引用文本。 可以包含多行内容。

嵌套引用

1
2
3
4
5
> 第一层引用
>
> > 第二层引用
> > 
> > 第三层引用

效果:

第一层引用

第二层引用

引用中包含其他元素

1
2
3
4
5
6
> ## 标题
> 
> 1. 列表项 1
> 2. 列表项 2
>
> `代码`

效果:

标题

  1. 列表项 1
  2. 列表项 2

代码


代码

行内代码

1
这是一段包含 `行内代码` 的文本。

效果:

这是一段包含 行内代码 的文本。

代码块

使用三个反引号:

1
2
3
4
5
```javascript
function hello() {
  console.log("Hello, World!");
}
```

效果:

1
2
3
function hello() {
  console.log("Hello, World!");
}

支持的语言

主题支持数百种语言的高亮:

语言 标识符
JavaScript javascript, js
Python python, py
Go go
Rust rust
Java java
C/C++ c, cpp
HTML html
CSS css
YAML yaml, yml
JSON json
Shell bash, sh, shell
SQL sql

表格

基本表格

1
2
3
4
| 列1 | 列2 | 列3 |
|-----|-----|-----|
| 数据1 | 数据2 | 数据3 |
| 数据4 | 数据5 | 数据6 |

效果:

列1 列2 列3
数据1 数据2 数据3
数据4 数据5 数据6

对齐方式

1
2
3
| 左对齐 | 居中 | 右对齐 |
|:-------|:----:|-------:|
| 内容 | 内容 | 内容 |

效果:

左对齐 居中 右对齐
内容 内容 内容

表格内使用格式

1
2
3
4
5
6
| 功能 | 状态 | 说明 |
|------|:----:|------|
| **粗体** | ✅ | 支持 |
| *斜体* | ✅ | 支持 |
| `代码` | ✅ | 支持 |
| [链接](./) | ✅ | 支持 |

效果:

功能 状态 说明
粗体 支持
斜体 支持
代码 支持
链接 支持

分割线

1
2
3
4
5
---

***

___

效果:


脚注

1
2
3
这是一个脚注示例[^1]。

[^1]: 这是脚注的内容。

效果:

这是一个脚注示例1


数学公式

行内公式

1
质能方程 $E = mc^2$ 是物理学基础。

效果:

质能方程 (E = mc^2) 是物理学基础。

块级公式

1
2
3
$$
\frac{\partial f}{\partial x} = \lim_{h \to 0} \frac{f(x+h) - f(x)}{h}
$$

效果:

[ \frac{\partial f}{\partial x} = \lim_{h \to 0} \frac{f(x+h) - f(x)}{h} ]


HTML 标签

Markdown 支持内嵌 HTML:

1
2
3
4
5
<div style="background: #f0f0f0; padding: 10px; border-radius: 5px;">
  <p>这是一个自定义 HTML 区块</p>
</div>

<kbd>Ctrl</kbd> + <kbd>C</kbd> 复制

效果:

这是一个自定义 HTML 区块

按下 Ctrl + C 复制


转义字符

使用反斜杠转义特殊字符:

1
2
3
\* 不是斜体 \*
\# 不是标题
\[ 不是链接

效果:

* 不是斜体 * # 不是标题 [ 不是链接


定义列表

1
2
3
4
5
6
术语 1
: 定义 1

术语 2
: 定义 2a
: 定义 2b

效果:

术语 1
定义 1
术语 2
定义 2a
定义 2b

缩写

1
2
3
4
*[HTML]: Hyper Text Markup Language
*[CSS]: Cascading Style Sheets

HTML 和 CSS 是前端基础。

效果:

*[HTML]: Hyper Text Markup Language *[CSS]: Cascading Style Sheets

HTML 和 CSS 是前端基础。


组合示例

技术文档风格

1
2
3
4
5
6
7
8
## 安装步骤

### 1. 下载依赖

运行以下命令:

```bash
npm install

2. 配置环境

创建配置文件:

参数 类型 必填 说明
apiUrl string API 地址
timeout number 超时时间(毫秒)

注意:确保 Node.js 版本 >= 16

3. 启动服务

1
npm start

访问 http://localhost:3000 查看效果。


**效果:**

## 安装步骤

### 1. 下载依赖

运行以下命令:

```bash
npm install

2. 配置环境

创建配置文件:

参数 类型 必填 说明
apiUrl string API 地址
timeout number 超时时间(毫秒)

注意:确保 Node.js 版本 >= 16

3. 启动服务

1
npm start

访问 http://localhost:3000 查看效果。


相关文档


掌握这些 Markdown 语法,让你的博客文章更专业、更易读!


  1. 这是脚注的内容,会显示在页面底部。 ↩︎