Markdown 语法指南
Markdown 是一种轻量级标记语言,它的目标是实现易读易写。可读性是最重要的,一份 Markdown 格式的文档应该能够直接以纯文本形式发布,而不会看起来像是被标记过的。
1. 基本语法
1.1 段落和换行
段落是由一个或多个连续的文本行组成,段落之间用空行分隔。普通段落不应该用空格或制表符缩进。
如果要插入换行符,在行末添加两个或更多空格,然后按回车键。
1.2 标题
Markdown 支持两种标题语法:
- Setext 风格(使用等号和横线):
1 | 这是 H1 标题 |
- ATX 风格(使用 # 号):
1 | # 这是 H1 标题 |
1.3 引用
使用 >
符号来创建引用块:
1 | > 这是一个引用块 |
1.4 列表
无序列表
使用 *
、+
或 -
来创建无序列表:
1 | * 项目一 |
有序列表
使用数字加点来创建有序列表:
1 | 1. 第一项 |
1.5 代码
行内代码
使用反引号 `
来标记行内代码:
1 | 使用 `printf()` 函数来打印文本 |
代码块
使用三个反引号来创建代码块:
1 | ```python |
1.6 链接和图片
链接
1 | [链接文字](URL "可选标题") |
图片
1 |  |
1.7 强调
使用 *
或 _
来标记强调:
1 | *斜体文本* |
1.8 表格
1 | | 表头 1 | 表头 2 | |
2. HTML 支持
Markdown 支持直接使用 HTML 标签。对于不在 Markdown 语法范围内的标记,你可以直接使用 HTML。
例如,要添加一个 HTML 表格:
1 | <table> |
3. 特殊字符
在 HTML 中,<
和 &
是特殊字符。在 Markdown 中,你可以直接使用这些字符,Markdown 会自动处理转义。
例如:
- 4 < 5 会被转换为 4< 5
- AT&T 会被转换为 AT&T
4. 最佳实践
- 保持文档结构清晰
- 使用适当的标题层级
- 保持列表格式一致
- 适当使用空行来提高可读性
- 代码块使用适当的语言标记
- 图片添加有意义的描述
- 链接使用有意义的文字