xuexi_wendang/yuwenhao/Markdown/Markdown.md

Markdown 学习文档

[TOC]

1. Markdown 简介

Markdown 是一种轻量级标记语言，主要通过简单符号控制文档结构和显示效果。它适合编写学习笔记、项目说明、接口文档、操作手册等内容。

Markdown 文档的优点：

• 语法简单，容易阅读和维护。
• 可以同时保留纯文本可读性和排版效果。
• 适合配合 Git 进行版本管理。
• 常用于 README、学习文档、开发文档和测试记录。

2. 标题语法

Markdown 使用 # 表示标题，# 数量越多，标题级别越低。

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

显示效果：

一级标题示例

二级标题示例

三级标题示例

注意事项：

• # 后面建议加一个空格。
• 一个文档中通常只保留一个一级标题。
• 标题层级应按顺序使用，避免结构混乱。

3. 列表语法

3.1 无序列表

无序列表通常使用 -、* 或 + 表示，推荐统一使用 -。

- SourceTree
- IAR
- Visual Studio

显示效果：

• SourceTree
• IAR
• Visual Studio

3.2 有序列表

有序列表使用数字加英文句点表示。

1. 创建工程
2. 添加文件
3. 编译运行

显示效果：

1. 创建工程
2. 添加文件
3. 编译运行

3.3 列表嵌套

子列表需要缩进，通常使用两个或四个空格。

- 软件学习
  - SourceTree
  - IAR
  - Visual Studio
- 文档学习
  1. Markdown 语法
  2. 图片引用
  3. 页面跳转

显示效果：

• 软件学习
  • SourceTree
  • IAR
  • Visual Studio
• 文档学习
  1. Markdown 语法
  2. 图片引用
  3. 页面跳转

4. 文字样式

4.1 加粗

**加粗文字**

显示效果：加粗文字

4.2 倾斜

*倾斜文字*

显示效果：倾斜文字

4.3 加粗倾斜

***加粗倾斜文字***

显示效果：加粗倾斜文字

4.4 删除线

~~删除线文字~~

显示效果：删除线文字

5. 代码块

5.1 单行代码

单行代码使用一对反引号包裹。

`printf("Hello World");`

显示效果：printf("Hello World");

5.2 多行代码

多行代码使用三个反引号包裹，并可以指定语言类型。

​```c
#include <stdio.h>

int main(void)
{
    printf("Hello World\n");
    return 0;
}
​```

显示效果：

#include <stdio.h>

int main(void)
{
    printf("Hello World\n");
    return 0;
}

6. 超链接

6.1 文字超链接

[百度](https://www.baidu.com)
[必应](https://www.bing.com)

显示效果：

百度

必应

6.2 图片超链接

图片外层再包一层链接语法，即可点击图片跳转。

[![Markdown 图片示例](pictures/Markdown_图片示例.png)](https://www.baidu.com)

显示效果：

7. 页面内跳转

7.1 跳转到标题

Markdown 可以通过标题生成锚点，并在文档内部跳转。

[跳转到表格](#10-表格)

显示效果：[跳转到表格](#10. 表格)

7.2 跳转到目录

可以在指定位置增加 HTML 锚点。

<span id="custom-target"></span>

然后使用链接跳转：

[跳转到指定位置](#custom-target)

显示效果：跳转到指定位置

8. 图片

图片语法由说明文字和图片路径组成。

![Markdown 图片示例](pictures/Markdown_图片示例.png)

显示效果：

图片引用注意事项：

• 图片建议统一放在当前文档目录下的 pictures 文件夹中。
• 推荐使用相对路径，例如 pictures/图片名称.png。
• 不建议使用本机盘符或用户桌面目录这类绝对路径。
• 图片文件名应尽量清晰，便于后续维护。

9. 分割线

分割线可以使用三个或更多 -、*、_。

---

显示效果：

---

+++

---

---

10. 表格

表格使用 | 分隔列，第二行用于控制表头。

| 序号 | 软件 | 作用 |
| ---- | ---- | ---- |
| 1 | SourceTree | 代码版本管理 |
| 2 | IAR | 嵌入式工程开发 |
| 3 | Visual Studio | C/C++ 工程开发和调试 |

显示效果：

序号	软件	作用
1	SourceTree	代码版本管理
2	IAR	嵌入式工程开发
3	Visual Studio	C/C++ 工程开发和调试

11. 引用

引用使用 > 表示，可以用于说明重点、备注或引用内容。

> 一级引用
>
> > 二级引用

显示效果：

一级引用

二级引用

12. 学习总结

12.1 考试知识点补充（按章节归类）

标题和快捷键补充

Markdown 标题使用 # 表示，几个 # 就是几级标题。常见编辑器中也可以用快捷键设置标题，例如：

标题级别	语法	常见快捷键
一级标题	# 标题	Ctrl + 1
二级标题	## 标题	Ctrl + 2
三级标题	### 标题	Ctrl + 3

考试中问“三级标题的快捷键”，应选 Ctrl + 3。

列表语法补充

无序列表常用符号包括：

- 内容
+ 内容
* 内容

~ 不是无序列表符号。列表嵌套时，子级列表通常需要在上一层列表下方缩进，一般按一次 Tab 即可形成下一级列表。

在有序列表或无序列表末尾，如果想退出列表并创建一个不带符号的空行，通常连续按两次 Enter。

文字样式补充

常见文字样式写法如下：

效果	写法
斜体	*文本* 或 _文本_
加粗	**文本** 或 __文本__
删除线	~~文本~~

文字样式符号一般紧贴文字，不需要在符号和文字之间额外加空格。例如斜体写成 *文本*，删除线写成 ~~文本~~。

代码补充

如果要把单词或短语显示为行内代码，使用一对反引号：

`code`

如果要显示多行代码块，使用三个反引号包裹：

​```c
int main(void)
{
    return 0;
}
​```

常见编辑器中，代码块快捷键可能是 Ctrl + Shift + K，而 Ctrl + K 往往不是完整代码块的快捷键。考试时要结合题目所给选项判断。

通过本次学习，掌握了 Markdown 的常用语法，包括标题、列表、文字样式、代码块、超链接、页面内跳转、图片、分割线、表格和引用。

整理 Markdown 文档时，需要特别注意目录结构和图片路径。文档和图片一起提交时，应优先使用相对路径，这样在其他电脑或仓库环境中打开文档时，图片也能正常显示。