Markdown 完整指南

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。本指南将带你从基础到进阶，全面掌握 Markdown 语法。

目录

• 基础语法
  • 标题
  • 段落和换行
  • 强调
  • 列表
  • 链接
  • 图片
  • 代码
  • 引用
  • 水平分割线
• 扩展语法
  • 表格
  • 删除线
  • 任务列表
  • 代码块
• 实用示例
• 最佳实践

基础语法

标题

使用 # 符号创建标题，支持 1-6 级标题：

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

段落和换行

段落之间用空行分隔。如果需要在段落内换行，在行末添加两个空格。

第二段。这里演示了段落的使用。

强调

• 斜体文本 或 斜体文本
• 粗体文本 或 粗体文本
• 粗斜体文本 或 粗斜体文本

列表

无序列表

使用 -、* 或 + 创建无序列表：

• 这一个
• 那一个
• 另一个
  • 嵌套项目
  • 另一个嵌套项目

有序列表

使用数字加点创建有序列表：

1. 第一项
2. 第二项
3. 第三项
   1. 嵌套编号项目
   2. 另一个嵌套编号项目

链接

创建链接的几种方式：

• 内联链接：链接文本
• 带标题的链接：链接文本
• 引用式链接：链接文本
• 自动链接：https://example.com

图片

插入图片的语法：

![替代文本](图片URL "可选标题")

代码

行内代码

使用反引号包围代码：console.log('Hello World')

代码块

使用三个反引号创建代码块：

function greet(name) {
    console.log(`Hello, ${name}!`);
}

greet('World');

或者使用缩进（4个空格）：

# 这是一个代码块
for i in 1 .. 10 { 
    do-something(i) 
}

引用

使用 > 创建引用：

这是一个引用块。

引用可以跨越多个段落。

这是嵌套引用。

水平分割线

使用三个或更多的 -、* 或 _ 创建水平线：

---

扩展语法

表格

创建表格使用管道符 | 分隔列：

姓名	年龄	城市
张三	25	北京
李四	30	上海
王五	28	广州

对齐方式：

左对齐	居中对齐	右对齐
内容	内容	内容

删除线

使用两个波浪号创建删除线：删除的文本

任务列表

创建任务列表：

• 已完成的任务
• 未完成的任务
• 另一个未完成的任务

实用示例

数学公式（如果支持）

行内公式：$E = mc^2$

块级公式：

$$\sum_{i=1}^{n} x_i = x_1 + x_2 + \cdots + x_n$$

脚注

这里有一个脚注¹。

高亮文本

==高亮文本==（部分编辑器支持）

最佳实践

1. 保持一致性：在整个文档中使用相同的语法风格
2. 适当使用空行：在不同部分之间添加空行提高可读性
3. 合理使用标题层级：保持标题的逻辑层次
4. 代码块指定语言：为代码块指定编程语言以获得语法高亮
5. 链接描述清晰：使用有意义的链接文本
6. 图片添加替代文本：为图片添加描述性的替代文本

高级技巧

HTML 内联

Markdown 支持内联 HTML，可以实现更复杂的格式：

点击展开详情

这里是隐藏的内容，点击上方可以展开或收起。

键盘按键

表示键盘按键：Ctrl + C

上标和下标

• 上标：E = mc²
• 下标：H₂O

缩写

*[HTML]: HyperText Markup Language *[CSS]: Cascading Style Sheets

HTML 和 CSS 是网页开发的基础技术。

特殊字符转义

如果需要显示 Markdown 语法字符，使用反斜杠转义：

• *不是斜体*
• [不是链接]
• `不是代码`
• # 不是标题
• > 不是引用

实际应用场景

技术文档

## API 接口

### 获取用户信息

**请求方式：** GET

**请求URL：** `/api/user/{id}`

**参数说明：**

| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| id     | int  | 是   | 用户ID |

**返回示例：**

```json
{
  "code": 200,
  "data": {
    "id": 1,
    "name": "张三",
    "email": "zhangsan@example.com"
  }
}

项目 README

# 项目名称

简短的项目描述

## 安装

```bash
npm install project-name

使用方法

const project = require('project-name');
project.doSomething();

贡献

欢迎提交 Pull Request！

### 博客文章

```markdown
# 文章标题

> 引言或摘要

## 正文

文章内容...

### 小结

- 要点一
- 要点二
- 要点三

---

**标签：** #技术 #教程

编辑器推荐

在线编辑器

• Typora - 所见即所得编辑器
• Mark Text - 实时预览编辑器
• Dillinger - 在线 Markdown 编辑器

VS Code 插件

• Markdown All in One
• Markdown Preview Enhanced
• markdownlint

总结

Markdown 是一种简单而强大的标记语言，掌握这些语法可以让你高效地编写格式化文档。无论是写博客、文档还是 README 文件，Markdown 都是一个优秀的选择。

学习建议

1. 从基础开始：先掌握标题、段落、列表等基本语法
2. 多加练习：在实际项目中使用 Markdown
3. 善用工具：选择合适的编辑器提高效率
4. 参考规范：遵循 CommonMark 或 GitHub Flavored Markdown 规范

记住：实践是最好的学习方式。多写多练，你很快就能熟练掌握 Markdown！

---

最后更新：2025年1月26日

Footnotes

1. 这是脚注的内容。 ↩