Markdown 测试文章 标题
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
技术文档:最多三级,少数到四级 博客/笔记:二级到三级最清晰 如需再细分:优先列表、加粗、引用 超过三级,说明结构设计有问题。
引用
引用他人内容
补充说明,不打断主线阅读
警告/提示 引用他人内容
补充说明,不打断主线阅读
警告/提示
引用不要当普通段落用、避免整篇文章大量引用 引用用于抽离语境,而不是组织结构 段落 这是一个段落。结束此段落,再按下两次回车。
这是新的段落。 这是一个段落。结束此段落,再按下两次回车。
这是新的段落。
md 以空行划分段落,一次回车 仅被识别为换行。
标准语法:标题与段落之间、段落与段落之间、各种元素之间,保持空一行。
加粗、倾斜 加粗文字
倾斜文字 加粗文字
倾斜文字
有序列表和无序列表 有序列表:
- 第一项
- 第二项
- 第三项
无序列表:
- 第一项
- 第二项
- 第三项
任务列表
- 已完成
- 未完成
- 未完成
代码
行内代码
这是一个行内 code 的例子。
` 转义反引号语法。
这是一个行内 code 的例子。
` 转义反引号语法。
代码块
#include <iostream>
int main() {
std::cout << "Hello World!" << std::endl;
return 0;
}
若想在代码块里表示代码块语法,外层 ` 数量多于内层。 表格
| 标题1 | 标题2 | 标题3 |
|---|---|---|
| 1-1 | 2-1 | 3-1 |
| 1-2 | 2-2 | 3-2 |
| 标题1 标题2 标题3 | ||
| 1-1 2-1 3-1 | ||
| 1-2 2-2 3-2 | ||
| :---:左对齐 | ||
| :---::局中对齐 | ||
| ---::右对齐 | ||
| 链接 | ||
| 行内链接 |
普通文档:行内链接 技术文档/规范:引用式链接
图片

这是图片
脚注 这是一段文字1
适用于:
解释性补充说明 不想打断正文阅读节奏 不适用:
README / 简短的说明文档 分隔线
有标题 → 不要分隔线 同一主题 → 不要分隔线 结构变化明显 → 可以用 这是脚注内容 ↩︎
Markdown语法 文档写作 技术写作 格式规范 排版技巧
Footnotes
- 这是脚注内容 这是一段文字1 ↩