Markdown 语法教程

Markdown 语法教程

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的 HTML 文档。本教程将介绍 Markdown 的常用语法。

1. 标题

Markdown 支持 6 级标题,使用 # 符号表示,# 的数量代表标题级别。

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

效果:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

2. 段落和换行

段落之间用空行分隔。如果需要在段落内换行,可以在行末添加两个空格或使用 <br> 标签。

这是第一个段落。

这是第二个段落。
这是第二行(行末两个空格)。

3. 文本样式

粗体和斜体

**粗体文本**
__粗体文本(另一种方式)__

*斜体文本*
_斜体文本(另一种方式)_

***粗斜体文本***
___粗斜体文本(另一种方式)___

效果:
粗体文本
斜体文本
粗斜体文本

删除线

~~删除线文本~~

效果:
~~删除线文本~~

4. 列表

无序列表

使用 -*+ 作为列表标记。

- 项目一
- 项目二
  - 子项目一
  - 子项目二
- 项目三

效果:
– 项目一
– 项目二
– 子项目一
– 子项目二
– 项目三

有序列表

使用数字加点的方式。

1. 第一项
2. 第二项
3. 第三项

效果:
1. 第一项
2. 第二项
3. 第三项

5. 链接

内联链接

[链接文本](URL "可选的标题")

示例:

[百度](https://www.baidu.com "百度一下")

效果:
百度

参考式链接

[链接文本][参考标识]

[参考标识]: URL "可选的标题"

示例:

[Google][google]

[google]: https://www.google.com "Google 搜索"

6. 图片

图片语法与链接类似,前面多一个 ! 符号。

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

示例:

![示例图片](images/example.jpg "这是一张示例图片")

7. 引用

使用 > 符号创建引用块,可以嵌套。

> 这是一段引用
>
> > 这是嵌套引用
> > 可以有多行

效果:

这是一段引用

这是嵌套引用
可以有多行

8. 代码

行内代码

使用反引号 ` 包裹代码。

这是 `行内代码` 的示例

效果:
这是 行内代码 的示例

代码块

使用三个反引号 “` 包裹代码块,可以指定语言。

```python
def hello():
    print("Hello, World!")
**效果:**
```python
def hello():
    print("Hello, World!")

9. 表格

使用 | 分隔列,使用 - 分隔表头和内容。可以设置对齐方式。

| 左对齐 | 居中对齐 | 右对齐 |
| :----- | :------: | -----: |
| 单元格1 | 单元格2  | 单元格3 |
| 单元格4 | 单元格5  | 单元格6 |

效果:

左对齐 居中对齐 右对齐
单元格1 单元格2 单元格3
单元格4 单元格5 单元格6

10. 分隔线

使用三个或更多的 *-_ 创建分隔线。

***

---

___

效果:




11. 任务列表

- [ ] 未完成任务
- [x] 已完成任务

效果:
– [ ] 未完成任务
– [x] 已完成任务

12. 转义字符

使用反斜杠 \ 转义特殊字符。

\*不是斜体\*
\[不是链接\]

效果:
*不是斜体*
[不是链接]

需要转义的字符包括:\ * _ {} [] () # + - . !

13. 自动链接

使用 <> 包裹 URL 或邮箱地址。

<https://www.example.com>
<user@example.com>

14. 脚注

这是一句话[^1]。

[^1]: 这是脚注的内容

15. HTML

Markdown 支持直接嵌入 HTML 标签。

<div style="color: red;">
  这是红色的文本
</div>

最佳实践

  1. 保持简洁:Markdown 的优势在于简洁,避免过度使用 HTML
  2. 使用空格:在中文和英文之间添加空格,提高可读性
  3. 规范缩进:嵌套列表时使用两个空格缩进
  4. 预览效果:编写时经常预览,确保格式正确
  5. 文件命名:使用 .md.markdown 扩展名

常用 Markdown 编辑器

  • VS Code:功能强大的代码编辑器,支持 Markdown 预览
  • Typora:所见即所得的 Markdown 编辑器
  • Mark Text:简洁的实时预览编辑器
  • Obsidian:知识管理和笔记工具

总结

Markdown 是一种简单而强大的文档编写工具,掌握基本语法即可高效地编写各种文档。随着使用经验的积累,你可以发现更多高级用法和技巧,充分发挥 Markdown 的潜力。