Markdown 常用语法总结

前言

  • Markdown是一种纯文本格式的标记语言。通过简单的标记语法,它可以使普通文本内容具有一定的格式。
  • 优点:
    • 因为是纯文本,所以只要支持Markdown的地方都能获得一样的编辑效果,可以让作者摆脱排版的困扰,专心写作。
    • 操作简单。比如WYSIWYG编辑时标记个标题,先选中内容,再点击导航栏的标题按钮,选择几级标题。要三个步骤。而Markdown只需要在标题内容前加#即可。
  • 缺点:
    • 需要记一些语法(当然,是很简单。五分钟学会)
    • 有些平台不支持Markdown编辑模式。

1. 标题

使用 # 表示标题, # 的个数表示标题的级别,一共支持 6 级标题。例如:

1
2
3
4
5
6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

2. 段落和换行

段落之间用空行分开。

换行需要在行尾加上两个空格然后回车。

3. 字体格式

  • 粗体:在文本外面用两个 * 或者 __ 包裹
  • 斜体:在文本外面用一个 * 或者 _ 包裹
  • 粗斜体:在文本外面用三个 * 或者 ___ 包裹

例如:

1
2
3
**这是粗体**  
*这是斜体*
***这是粗斜体***

4. 分割线

使用三个或更多 - 或者 * 来添加分隔线,例如:

1
2
---
***

5. 列表

无序列表

使用 -
或者 * 加空格来表示无序列表,例如:

1
2
3
4
5
6
7
- 列表项1
- 列表项2
- 列表项3

* 列表项1
* 列表项2
* 列表项3

有序列表

使用数字加点来表示有序列表,例如:

1
2
3
1. 列表项1
2. 列表项2
3. 列表项3

6. 区块引用

使用 > 表示区块引用,多层引用可以使用 >> 或者多层嵌套的 > 来表示:

1
2
3
> 第一层区块引用
>> 第二层区块引用
>>> 第三层区块引用

7. 代码块

行内代码

使用单个反引号 ` 来表示行内代码。

代码块

使用三个反引号 ``` 来表示代码块,可以指定编程语言:

```python
print(“Hello World”)
```

```java
System.out.println(“Hello World”)
```

8. 链接

格式为 [链接文本](链接地址 "标题") :

1
[简书](https://www.jianshu.com "写作社区")

9. 图片

格式为 ![图片alt](图片链接 "标题"):

1
![头像](https://www.example.com/avatar.png "我的头像")

10. 表格

使用 | 来分隔不同的单元格,使用 - 来分隔表头和内容:

1
2
3
| 表头1 | 表头2 |
|-|-|
| 内容1 | 内容2 |

11. 图标

可以使用 MitchDZug/Emoji-Cheatsheet 仓库提供的 Emoji 编码来显示图标:

1
:smile: :+1: :car:

12.图表

  • 使用图床保存图片,然后使用标准的 Markdown 图像语法插入
    1
    ![图表名称](图表图片URL)
  • 使用Mermaid语言绘制图表, Mermaid支持流程图、时序图、甘特图等
    1
    2
    graph LR
    A-->B-->C
  • 使用PlantUML语言绘制UML图表,如时序图、类图等
    1
    2
    3
    @startuml
    Alice -> Bob: Hi!
    @enduml
  • 使用Chart.js等JavaScript图表库,在Markdown中嵌入HTML代码来插入交互式图表
    1
    2
    3
    4
    5
    <canvas id="myChart"></canvas>

    <script>
    // Chart.js代码生成图表
    </script>
  • 使用支持LaTeX数学公式的Markdown编辑器,直接插入LaTeX图表代码
    1
    $$f(x)=\int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi$$