跳转至

Markdown 速查指南

Markdown 是一种轻量级标记语言，让你用纯文本格式编写文档，再转换成 HTML。

1. 标题

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

效果：

一级标题

二级标题

三级标题

2. 文本样式

**粗体** 或 __粗体__
*斜体* 或 _斜体_
***粗斜体***
~~删除线~~
`行内代码`
<u>下划线</u>
 ==高亮== （部分编辑器支持）

效果：粗体 斜体 粗斜体 删除线 行内代码

3. 列表

无序列表

- 项目一
- 项目二
  - 子项目（缩进 2 空格）
  - 子项目
- 项目三

有序列表

1. 第一项
2. 第二项
3. 第三项

任务列表

- [x] 已完成任务
- [ ] 未完成任务
- [ ] 另一个任务

效果：

  • [x] 已完成任务
  • [ ] 未完成任务

4. 链接

[显示的文本](https://example.com)

[带标题的链接](https://example.com "鼠标悬停显示的文本")

[引用式链接][reference]

[reference]: https://example.com

5. 图片

![替代文本](https://example.com/image.png)

![带标题的图片](https://example.com/image.png "图片标题")

6. 代码块

行内代码

使用 `print("Hello")` 打印内容。

代码块（带语法高亮）

```python
def hello():
    print("Hello, Markdown!")
```

效果：

def hello():
    print("Hello, Markdown!")

7. 引用

> 这是一段引用
>
> > 这是嵌套引用
>
> 引用可以包含 **格式** 和 `代码`

效果：

这是一段引用

这是嵌套引用

引用可以包含 格式 和 代码

8. 表格

| 左对齐 | 居中对齐 | 右对齐 |
| :--- | :---: | ---: |
| 苹果 | 香蕉 | 樱桃 |
| 100 | 200 | 300 |
| 左 | 中 | 右 |

效果：

左对齐 居中对齐 右对齐
苹果 香蕉 樱桃
100 200 300
左 中 右

9. 水平分割线

---

***

___

三种方式效果一样，都生成一条水平线。

10. 脚注

这是一段需要注释的文字[^1]。

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

11. 表情符号（Emoji）

:smile: :heart: :+1: :rocket: :fire:

效果：😄 ❤️ 👍 🚀 🔥

12. 折叠/详情（部分编辑器支持）

<details>
<summary>点击展开</summary>

这里是隐藏的内容，支持 **Markdown** 语法。

</details>

13. 转义字符

在 Markdown 中，如果希望显示特殊字符本身，可以用反斜杠 \ 转义：

\* 这不是斜体 \*
\# 这不是标题

实战练习 🎯

现在你可以试试创建自己的 Markdown 文件，或者修改 docs/index.md 来练习！以下是一些练习建议：

  1. 创建一个 docs/about.md 页面，介绍你自己
  2. 在页面中添加图片、表格和代码块
  3. 使用不同级别的标题组织内容
  4. 尝试引用和列表的组合

💡 提示：修改文件后，mkdocs 会自动刷新浏览器页面，无需手动刷新！