简介
Markdown是一种轻量级标记语言,让您可以使用易读易写的纯文本格式编写文档。本速查表涵盖了从基础到高级的所有Markdown语法,并提供了实用示例。无论您是Markdown新手还是想要查阅特定语法,这份指南都能为您提供帮助。
基础语法
标题(Headings)
Markdown支持六级标题,使用#
符号表示:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
也可以使用下划线形式(仅支持一级和二级):
一级标题
========
二级标题
--------
段落和换行
段落之间需要空行分隔。如果需要换行而不开始新段落,在行尾添加两个空格。
这是第一段。
这是第二段。
这是一行
这是下一行(注意上一行末尾的两个空格)
文本格式
效果 | 语法 | 示例 |
---|---|---|
粗体 | **文本** 或 __文本__ |
粗体文本 |
斜体 | *文本* 或 _文本_ |
斜体文本 |
粗斜体 | ***文本*** 或 ___文本___ |
粗斜体文本 |
删除线 | ~~文本~~ |
|
下划线 | <u>文本</u> |
下划线文本 |
列表
无序列表
使用-
、+
或*
创建无序列表:
- 项目一
- 项目二
- 子项目 2.1
- 子项目 2.2
- 项目三
+ 也可以使用加号
* 或者星号
有序列表
使用数字加点创建有序列表:
1. 第一项
2. 第二项
1. 子项目 2.1
2. 子项目 2.2
3. 第三项
任务列表
GitHub风格的任务列表:
- [x] 已完成任务
- [ ] 待办任务
- [ ] 另一个待办任务
链接
行内链接
[链接文本](https://www.example.com)
[带标题的链接](https://www.example.com "链接标题")
参考链接
[链接文本][参考标识]
[参考标识]: https://www.example.com "可选标题"
自动链接
<https://www.example.com>
<[email protected]>
图片


参考式图片:
![替代文本][图片参考]
[图片参考]: 图片URL "可选标题"
引用
> 这是一段引用
> 可以有多行
>
> > 还可以嵌套引用
代码
行内代码
使用`反引号`包围行内代码
代码块
使用三个反引号或缩进四个空格:
```javascript
function hello() {
console.log("Hello, World!");
}
```
或者使用缩进(四个空格)
function hello() {
console.log("Hello, World!");
}
分隔线
使用三个或更多的连字符、星号或下划线:
---
***
___
高级语法
表格
| 列1 | 列2 | 列3 |
|-----|-----|-----|
| 数据1 | 数据2 | 数据3 |
| 数据4 | 数据5 | 数据6 |
对齐方式:
| 左对齐 | 居中 | 右对齐 |
|:-------|:----:|-------:|
| 左 | 中 | 右 |
脚注
这是一个脚注示例[^1]。
[^1]: 这是脚注内容。
定义列表
术语1
: 定义1
术语2
: 定义2a
: 定义2b
缩写
HTML是超文本标记语言。
*[HTML]: Hyper Text Markup Language
GitHub风格Markdown(GFM)
语法高亮
在代码块中指定语言:
```python
def hello():
print("Hello, World!")
```
```json
{
"name": "example",
"version": "1.1.0"
}
```
表情符号
:smile: :heart: :thumbsup: :star:
用户提及和问题引用
@用户名
#123 (问题编号)
组织/仓库#123
HTML支持
Markdown支持内嵌HTML:
<div style="color: red;">
这是红色文本
</div>
<details>
<summary>点击展开</summary>
隐藏的内容
</details>
转义字符
使用反斜杠转义特殊字符:
\* 不是斜体
\# 不是标题
\[不是链接\]
需要转义的字符:
\ ` * _ {} [] () # + - . ! |
最佳实践
1. 保持一致性
- 选择一种标题风格并坚持使用
- 统一使用
*
或-
作为列表标记 - 保持缩进一致(通常使用2或4个空格)
2. 可读性优先
- 在标题前后添加空行
- 段落之间使用空行分隔
- 避免过长的行(建议80-100字符)
3. 语义化使用
- 按层级使用标题,不要跳级
- 使用合适的标记(如列表、引用等)
- 为链接和图片提供描述性文本
常见错误
1. 列表格式错误
错误:
-项目一(缺少空格)
- 项目二
正确:
- 项目一
- 项目二
2. 链接格式错误
错误:
(链接文本)[URL]
正确:
[链接文本](URL)
3. 代码块缩进
错误:
```
代码
```
正确:
```
代码
```
工具技巧
使用MD-PDF-WORD
MD-PDF-WORD完美支持所有这些Markdown语法,并能准确地转换为PDF和Word格式:
- 保留所有格式
- 正确渲染表格
- 支持代码高亮
- 处理中文排版
快捷键(常见编辑器)
功能 | Windows/Linux | Mac |
---|---|---|
粗体 | Ctrl + B | Cmd + B |
斜体 | Ctrl + I | Cmd + I |
链接 | Ctrl + K | Cmd + K |
代码 | Ctrl + ` | Cmd + ` |
学习资源
- 官方规范:Markdown官方文档
- GitHub指南:GitHub Markdown指南
- 交互式教程:Markdown Tutorial
- 在线预览:使用MD-PDF-WORD的实时预览功能
总结
掌握Markdown语法能让您更高效地创建格式化文档。从基础的文本格式到高级的表格和代码块,Markdown提供了丰富而简洁的语法。配合MD-PDF-WORD等工具,您可以轻松地将Markdown文档转换为专业的PDF或Word格式,满足各种文档需求。
记住,Markdown的核心理念是让您专注于内容而不是格式。选择您需要的语法,保持简洁,让您的文档既美观又易于维护。