Markdown 语法速查

以下是编写文档时最常用的 Markdown 语法。

标题

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

# 越多层级越深。导航会自动根据标题生成目录结构。

文字格式

**加粗文字**
*斜体文字*
`行内代码`

代码块

```cpp
int main() {
    return 0;
}
```

语言标识（cpp、python、bash 等）用于语法高亮，可以省略。

引用（灰色批注）

> 这是一条引用/批注，会显示为灰色背景。
>
> 多行引用中间加一个空 `>` 即可。

效果：

这是一条引用/批注，会显示为灰色背景。

链接

[链接文字](https://example.com)

<!-- 跳转到同目录的其他文件 -->
[指针](./指针.md)

<!-- 跳转到上级目录的文件 -->
[C++ 基础](../C++基础/index.md)

图片

![图片描述](image.png)

图片文件放在与 .md 文件同一目录下即可。

下载链接

如果需要在文档中提供文件下载（如 PDF、Excel 等），不要直接把文件放进仓库——我们的服务器资源有限。正确做法：

1. 将文件上传到任意云盘 / 图床
2. 在浏览器中打开文件，点击下载
3. 从浏览器的下载记录中复制下载直链
4. 使用该链接即可：

[点击下载](https://example.com/download/file.pdf)

表格

| 列1 | 列2 | 列3 |
|-----|-----|-----|
| 内容 | 内容 | 内容 |
| 内容 | 内容 | 内容 |

分隔线

---

文件间跳转

MkDocs 中链接另一个 .md 文件使用相对路径：

<!-- 同目录 -->
[Vofa 调试指南](./Vofa.md)

<!-- 跨目录 -->
[嵌入式基础概述](../培训/嵌入式基础/01-嵌入式系统概述与HAL库.md)