Markdown Cheatsheet

发表于 2025-03-17

更新于 2025-09-03

阅读量 加载中...

该文档主要介绍在编写markdown文档时常用到的语法

• 标题
• 加粗 & 斜体
• 列表
• 链接
• 引用
• 代码块
• 分割线
• 参考

标题

使用 # 号表示标题，# 的数量表示标题级别。

# 一级标题
## 二级标题
### 三级标题

加粗 & 斜体

• 加粗：**加粗文本**
• 斜体：*斜体文本*
• 加粗 + 斜体：***加粗斜体文本***

👉 示例：

加粗文本
斜体文本
加粗斜体文本

列表

• 无序列表使用 - 或 *
• 有序列表使用 1. 2. 3.

- 无序项 1
- 无序项 2

1. 有序项 1
2. 有序项 2

👉 示例：

• 无序项 1
• 无序项 2

1. 有序项 1
2. 有序项 2

链接

格式：[链接文字](链接地址)

[链接名称](https://example.com)

引用

使用 > 表示引用。

> 这是一个引用示例

👉 示例：

这是一个引用示例

代码块

• 行内代码：使用 ```（反引号）包裹
• 多行代码块：使用三个反引号 ``` 包裹

`行内代码`

单行代码块示例：

const x = 5

多行代码块示例：

const function = () => {
    console.log("example code block")
}

分割线

使用 --- 或 *** 添加分割线。

---

👉 示例：

---

参考

• Markdown 语法指南