Markdown 终极速查表：语法、预览与最佳实践
Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。它被广泛用于 README 文件、技术文档和博客文章。由于其易于阅读和编写的特性，Markdown 已成为开发者交流的标准。
本速查表可作为标准 Markdown 和 GitHub Flavored Markdown (GFM) 语法的快速参考。
1. 文本格式化
为您的文本添加基本样式。
| 元素 | 语法 | 结果 |
|---|---|---|
| 标题 | # H1 到 ###### H6 |
H1 到 H6 |
| 加粗 | **文本** 或 __文本__ |
文本 |
| 斜体 | *文本* 或 _文本_ |
文本 |
| 删除线 | ~~文本~~ |
|
| 引用 | > 引用内容 |
> 引用内容 |
| 分割线 | --- 或 *** |
2. 列表
使用有序、无序或任务列表组织内容。
- 无序列表：使用
*、-或+。- 项目 1 - 项目 2 - 子项目 - 有序列表：使用数字加英文句点。
1. 第一项 2. 第二项 - 任务列表 (GFM)：
- [x] 已完成任务 - [ ] 未完成任务
3. 链接与图片
- 链接：
[文本](URL)-> 百度 - 图片：
 - 带标题的链接：
[文本](URL "标题")
4. 代码块
- 行内代码：使用反引号：
`代码`。 - 代码块：使用三个反引号，并可指定语言：
```javascript console.log("Hello, World!");
5. 表格与高级语法
表格：
| 标题 1 | 标题 2 |
| :--- | :--- |
| 单元格 1 | 单元格 2 |
| 单元格 3 | 单元格 4 |
脚注：
这是一个脚注引用[^1]。
[^1]: 这是脚注的具体内容。
6. Markdown 的不同版本 (Flavors)
- CommonMark：标准且具有高度兼容性的 Markdown 版本。
- GitHub Flavored Markdown (GFM)：增加了对表格、任务列表、删除线和自动链接的支持。大多数现代渲染器都支持 GFM。
- Markdown 中的 HTML：您可以在 Markdown 中直接使用原始 HTML 标签（如
<u>或<div>）来实现更复杂的布局，但出于安全考虑，某些渲染器可能会禁用此功能。
常见问题 (FAQ)
Q: 我该如何预览 Markdown？
A: 大多数代码编辑器（如 VS Code）都有内置的 Markdown 预览 功能 (Ctrl+Shift+V)。您也可以使用在线 Markdown 渲染器 或专用编辑器来查看文档转换为 HTML 后的样式。
Q: Markdown 编辑器和渲染器有什么区别？
A: 编辑器 是您编写纯文本语法的地方。渲染器（或解析器）则是将这些语法转换为 HTML 以供浏览器显示的引擎。
Q: 编写 Markdown 的最佳实践有哪些？
A:
- 一致性：在整个文档中保持列表（使用
-或*）和标题样式的一致。 - 可读性：在段落和列表项之间保留空行。
- 替代文本 (Alt Text)：始终为图片提供有意义的替代文本，以提高可访问性。
- 代码语言标注：始终为代码块指定语言，以启用语法高亮。
Tool3M 上的相关工具
- Markdown 转 HTML：立即将您的 Markdown 转换并预览为整洁、可直接用于生产环境的 HTML。
- SQL 格式化：格式化 SQL 代码块，方便粘贴到您的 Markdown 文档中。