
Markdown完整指南 - 从基础到进阶
📷 Markus Winkler / PexelsMarkdown完整指南 - 从基础到进阶
通过这份全面指南掌握Markdown,涵盖从基本格式到表格、任务列表、脚注和GitHub Flavored Markdown的所有语法。包含示例和最佳实践。
简介:什么是Markdown?
Markdown是2004年由John Gruber创建的轻量级标记语言。其主要目标是在原始形式下尽可能易于阅读,同时能够转换为结构有效的HTML。如今,Markdown已成为网络内容写作的事实标准——从文档和README文件到博客文章、评论和消息平台。
想在阅读本指南的同时练习?使用我们的Markdown预览工具实时查看Markdown渲染效果。
为什么使用Markdown?
- 可读性:即使不渲染,原始Markdown也易于阅读
- 可移植性:Markdown文件是纯文本,可在任何地方使用
- 简洁性:语法直观,易于学习
- 广泛支持:GitHub、GitLab、Reddit、Stack Overflow、Notion、Obsidian等均支持
- 版本控制友好:纯文本格式与Git完美配合
- 可转换:可转换为HTML、PDF、DOCX等多种格式
- 专注内容:让您专注于写作而非格式
基本语法
标题
通过在标题文本前添加1至6个#符号来创建标题:
# 标题1 (H1)
## 标题2 (H2)
### 标题3 (H3)
#### 标题4 (H4)
##### 标题5 (H5)
###### 标题6 (H6)
标题最佳实践:
- 始终在
#和标题文本之间加一个空格 - 每个文档只使用一个H1(通常是标题)
- 不要跳过标题级别(从H2到H3,不要从H2跳到H4)
- 保持标题简洁且具有描述性
强调(粗体和斜体)
*斜体文本* 或 _斜体文本_
**粗体文本** 或 __粗体文本__
***粗体和斜体*** 或 ___粗体和斜体___
~~删除线文本~~
引用块
> 这是一个引用块。
>
> 它可以跨多个段落。
> 引用块可以嵌套。
>
>> 这是一个嵌套的引用块。
列表
无序列表使用-、*或+:
- 项目1
- 项目2
- 嵌套项目2.1
- 嵌套项目2.2
- 项目3
有序列表使用数字后跟句点:
1. 第一项
2. 第二项
3. 第三项
链接和图片
链接
[链接文本](https://example.com)
[带标题的链接](https://example.com "链接标题")
<https://example.com>(自动链接)
图片


代码
行内代码
用单个反引号包裹行内代码:
使用`console.log()`函数进行调试。
代码块
使用三个反引号和可选的语言标识符进行语法高亮:
```javascript
function greet(name) {
return `Hello, ${name}!`;
}
```
```python
def greet(name):
return f"Hello, {name}!"
```
表格
使用管道符(|)和连字符(-)创建表格:
| 功能 | 免费版 | 专业版 | 企业版 |
|------|--------|--------|--------|
| 用户数 | 1 | 10 | 无限制 |
| 存储 | 1 GB | 100 GB | 1 TB |
| 支持 | 社区 | 邮件 | 24/7电话 |
渲染结果:
| 功能 | 免费版 | 专业版 | 企业版 |
|---|---|---|---|
| 用户数 | 1 | 10 | 无限制 |
| 存储 | 1 GB | 100 GB | 1 TB |
| 支持 | 社区 | 邮件 | 24/7电话 |
GitHub Flavored Markdown (GFM)
任务列表
- [x] 完成项目设置
- [x] 编写文档
- [ ] 添加单元测试
- [ ] 部署到生产环境
渲染结果:
- 完成项目设置
- 编写文档
- 添加单元测试
- 部署到生产环境
表情符号
GFM支持表情符号短代码:
:smile: :rocket: :bug: :white_check_mark: :warning:
脚注
这个说法需要来源[^1]。
[^1]: 来源:计算机科学杂志,2026年。
GitHub警告框
> [!NOTE]
> 用户应该知道的有用信息。
> [!WARNING]
> 需要立即关注的紧急信息。
Markdown最佳实践
- 从单个H1开始:这通常是文档标题
- 分层使用标题:H2用于主要章节,H3用于子章节
- 保持段落简短:每段3-5句话
- 始终指定代码语言:使用带语言标识符的围栏代码块
- 使用描述性链接文本:避免"点击这里",使用有意义的文本
常见Markdown使用场景
README文件
每个GitHub仓库都应该有一个README.md,包含:
# 项目名称
项目简短描述。
## 功能
- 功能1
- 功能2
- 功能3
## 安装
\`\`\`bash
npm install project-name
\`\`\`
## 使用方法
\`\`\`javascript
import { tool } from 'project-name';
tool.execute();
\`\`\`
Markdown快速参考
| 元素 | 语法 | 备注 |
|---|---|---|
| 标题 | # H1 到 ###### H6 | #后加空格 |
| 粗体 | **文本** | 或__文本__ |
| 斜体 | *文本* | 或_文本_ |
| 删除线 | ~~文本~~ | GFM功能 |
| 引用块 | > 文本 | 可嵌套 |
| 有序列表 | 1. 项目 | 数字自动递增 |
| 无序列表 | - 项目 | 也可用*或+ |
| 行内代码 | `代码` | 单个反引号 |
| 代码块 | ``` | 三个反引号 |
| 链接 | [文本](url) | 标题可选 |
| 图片 |  | 标题可选 |
| 水平线 | --- | 也可用***或___ |
| 表格 | | 列 | 列 | | GFM功能 |
| 任务列表 | - [x] 完成 | GFM功能 |
| 脚注 | 文本[^1] | 并非通用 |
结语
Markdown是每个开发者和技术写作者都应该掌握的强大而简洁的工具。其纯文本格式使其完美适用于版本控制文档、博客文章、README文件等。
要练习Markdown写作并即时看到渲染效果,请使用我们免费的Markdown预览工具。
相关资源
- Markdown预览工具 — 实时预览您的Markdown
- 字数统计器 — 统计Markdown文档的字数
- JSON格式化工具 — 为代码示例格式化JSON
- 正则表达式初学者指南 — 学习文本处理的正则表达式