Skip to content

📌 Markdown Cheatsheet

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

标题

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

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

加粗 & 斜体

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

👉 示例

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

列表

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

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

👉 示例

  • 无序项 1
  • 无序项 2
  1. 有序项 1
  2. 有序项 2

链接

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

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

引用

使用 > 表示引用。

markdown
> 这是一个引用示例

👉 示例

这是一个引用示例

代码块

  • 行内代码:使用 ```(反引号)包裹
  • 多行代码块:使用三个反引号 ``` 包裹
markdown
`行内代码`

单行代码块示例:

const x = 5

多行代码块示例:

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

分割线

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

markdown
---

👉 示例


参考