一文了解Markdown语法

最新推荐文章于 2024-08-06 19:00:00 发布

致星空

最新推荐文章于 2024-08-06 19:00:00 发布

阅读量434

点赞数

分类专栏：杂项文章标签： vscode markdown

本文链接：https://blog.csdn.net/m0_52027873/article/details/122013223

版权

杂项专栏收录该内容

6 篇文章 1 订阅

订阅专栏

一文了解Markdown语法

目录 {#index}

文章目录

一文了解Markdown语法
目录 {#index}
0 前言
1 基本语法
- 1.1 标题
我展示的是一级标题
- 我展示的是二级标题
一级标题
2 进阶语法
3 常用技巧
- 3.1 快捷键
4 拓展
参考

0 前言

写过博客或者github上面的README文档的，应该知道Markdown。Markdown 是一种轻量级标记语言，它允许人们使用易写的纯文本格式编写文档。通过简单的标记语法，它可以使普通文本内容具有一定的格式。Markdown 编写的文档后缀为 .md或 .markdown。

现在markDown编译器和各平台的支持情况都不太统一，具体支持的语法集以实际使用的编译器或平台而定。

Markdown的特点：

排版简单
编写的文档可以导出 HTML 、Word、图像和PDF 等多种格式。
支持平台众多，如GitHub、简书、CSDN、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。
Markdown语法集合比较小，只是HTML标签的一小部分。

Markdown的应用：

用来写博客、邮件
排版后转化成 HTML 或者 PDF

Markdown的编辑器：
很多支持Markdown的平台都提供Markdown编辑功能，例如CSDN等。但是为了方便编辑，可以选择专门的编辑器，如 Typora 、VS code的插件等。

1 基本语法

1.1 标题

Markdown 标题有两种格式。

1. 使用 = 和 - 标记一级和二级标题
使用一个及以上的 = 和 - 标记一级和二级标题。

我展示的是一级标题
=================

我展示的是二级标题
-----------------

效果：

我展示的是一级标题

我展示的是二级标题

2. 使用 # 号标记
使用 # 号可表示 1-6 级标题，一级标题对应一个 # 号，二级标题对应两个 # 号，以此类推。

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

效果：

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

1.2 文字编辑

1.2.1 文字斜体、粗体

*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

效果：
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本

1.2.2 文字删除线

如果要在文字上添加删除线，只需要在文字的两端加上两个波浪线 ~~ 即可。

markdown 致星空
~~markdown 致星空~~

效果：
markdown 致星空
~~markdown 致星空~~

1.2.3 文字下划线

下划线可以通过 HTML 的 标签来实现。

<u> markdown 致星空 </u>

效果：
markdown 致星空

1.3 段落

Markdown 段落可以用两种方式实现：

段尾使用两个以上空格加上回车。
段落后面使用一个空行来表示重新开始一个段落。

1.4 分隔线

用三个以上的星号、负号、下划线来建立一个分隔线，但行内不能有其他东西。在星号或是负号中间可以插入空格。
注意：
markdown中三个连续负号（—）上面一行如果是空行，则绘制分割线；如果上面一行有文字，则上面一行升级为2级标题（##）。

***
* * *
*****
- - -
----------
___

效果：

1.5 列表

返回目录
Markdown 支持有序列表和无序列表。
1. 无序列表
无序列表使用星号、加号或减号(*、+、-）作为列表标记，这些标记后面要添加一个空格与内容隔开。

* 第一项
+ 第二项
- 第三项

效果：

第一项

第二项

第三项

2. 有序列表
有序列表使用数字并加上 . 号来表示。

1. 第一项
2. 第二项

效果：

第一项
第二项

3. 定义型列表
定义型列表由名词和解释组成，第一行写定义，紧跟一行写解释。解释格式:“：”+缩进(Tab)+内容。

代码块 1 
:    内容1

代码块 2
:   内容1

        代码块（左侧有8个不可见的空格）

效果：

代码块 1

内容1

代码块 2

内容1

  代码块（左侧有8个不可见的空格）

4. 列表嵌套
列表嵌套只需在子列表中的选项前面添加“四个空格”即可。

1. 第一项：
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项：
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

效果：

第一项：
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
第二项：
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素

1.6 区块或引用

返回目录
1. 区块的基本使用
Markdown区块引用是在段落开头使用 > 符号，然后后面紧跟一个空格符号。

> 致星空

效果：

致星空

区块是可以嵌套的，以 > 的数目计算嵌套的层数，一个 > 符号是最外层，两个 > 符号是第一层嵌套，以此类推。

> 最外层
> > 第一层嵌套
> > > 第二层嵌套

效果：

最外层

第一层嵌套

第二层嵌套

2. 区块中使用列表

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

效果：

区块中使用列表

第一项
第二项

第一项
第二项
第三项

3. 区块中使用列表
在列表项目内放进区块，那么就需要在 > 前添加四个空格的缩进。

* 第一项
    > 菜鸟教程
    > 学的不仅是技术更是梦想
* 第二项

效果：

第一项

菜鸟教程
学的不仅是技术更是梦想
第二项

1.7 代码段

返回目录
1. 行内式
如果是段落上的一个函数或片段的代码可以用反引号把它包起来（`）。

函数`print()`

效果：
函数print()
2. 代码块

用“ 三个反引号```"或三个以上数目反引号包裹一段代码。如果代码已经用三个反引号标记代码片段，例如流程图，则可以用三个以上反引号包裹代码段。注意：成对的反引号数目一致。

```
print()
```

效果：

print()

使用 4 个空格或者1个制表符（Tab 键）。
效果：
```
print()
```

1.8 脚注

脚注是对文本的补充说明，补充内容在文末。

[^要注明的文本]
致星空[^1]
[^1]: Markdown 致星空：脚注

效果：
致星空¹

1.9 链接

返回目录

1.9.1 链接

1. 行内式
[]里写链接名称，()里写链接地址, ()中""引起来的内容为链接指定title属性，title属性可加可不加。title的效果是鼠标悬停在链接上会出现指定的 title文字，链接地址与title前有一个空格

[链接名称](链接地址)

[百度](https://www.baidu.com/?tn=99140155_hao_pg)

效果：
百度

2. 自动链接
用尖括号包裹url，这样生成的url锚文本就是url本身。

<链接地址>

<https://www.baidu.com/?tn=99140155_hao_pg>

效果：
https://www.baidu.com/?tn=99140155_hao_pg

3. 变量链接或参考式链接
通过变量来设置一个链接，在文档末尾进行变量赋值。

这个链接用 b 作为网址变量 [baidu][b]
[b]: https://www.baidu.com/?tn=99140155_hao_pg

效果：
这个链接用 b 作为网址变量 [baidu][b]
[b]: https://www.baidu.com/?tn=99140155_hao_pg

1.9.2 锚点（页内超链接）

为了方便文章阅读，有时需要页内跳转，例如目录到内容的跳转。但是有时需要从某个位置A导航到指定位置B，这就需要通过锚点实现。锚点是页内超链接，即链接本文档内部的某些元素，实现当前页面内的跳转。
在指定元素后插入锚点{#标记}，然后在文档的其它地方写上连接到锚点的链接。

# 目录{#index}
返回[目录](#index)

效果：
返回目录

注意：

Markdown只支持在标题后插入锚点，其它地方无效。其他地方需要借助HTML实现。
不是所有平台都支持该方式跳转，如CSDN，不行的话利用HTML语法实现。

1.10 图片

返回目录
1. 普通形式图片

![属性文本](图片地址)
![属性文本](图片地址 “可选标题”)

开头的感叹号 !表示为图片连接
接着一个方括号，里面放上图片的替代文字
接着一个普通括号，里面放上图片的网址，最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。网址可以是URL，也可以说本地地址。

![Python图片](https://baike.baidu.com/pic/Python/407313/0/faedab64034f78f092033e1079310a55b2191ccc?fr=lemma&ct=single#aid=0&pic=faedab64034f78f092033e1079310a55b2191ccc)

效果：
Python图片

2. 变量形式图片
也可以像网址那样对图片网址使用变量。

这里用 2 作为网址变量 [Python图片][2],然后在文档的结尾为变量赋值（网址）。

[2]: https://baike.baidu.com/pic/Python/407313/0/faedab64034f78f092033e1079310a55b2191ccc?fr=lemma&ct=single#aid=0&pic=faedab64034f78f092033e1079310a55b2191ccc

效果：
这里用 2 作为网址变量 [Python图片][2],然后在文档的结尾为变量赋值（网址）。
[2]: https://baike.baidu.com/pic/Python/407313/0/faedab64034f78f092033e1079310a55b2191ccc?fr=lemma&ct=single#aid=0&pic=faedab64034f78f092033e1079310a55b2191ccc

3. 指定图片的高度与宽度
Markdown 还没有办法指定图片的高度与宽度，但可以使用HTML的普通<img> 标签。

<img src="https://i-blog.csdnimg.cn/blog_migrate/dc1ba45384f6c14ea57db6fdd3d34ab2.png" width="50%">

效果：

1.11 转义字符

返回目录
Markdown 使用了很多特殊符号来表示特定的意义，如果需要显示特定的符号则需要使用转义字符，Markdown 使用反斜杠转义特殊字符。

**文本加粗**
\*\* 正常显示星号 \*\*

效果：
文本加粗
** 正常显示星号 **

Markdown 支持以下这些符号前面加上反斜杠\来帮助插入普通的符号：

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

1.12 生成目录

[TOC]标记编辑器会把所有标题写到目录大纲中,从而形成文章目录。[TOC]要单独占据一行，[TOC]代码所在位置即为目录位置。
效果：
效果参见最上方的目录

1.13 表格

返回目录
1. 制作表格
Markdown 使用 | 来分隔不同的单元格，使用 - 来分隔表头和其他行。

| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |

效果：

表头	表头
单元格	单元格
单元格	单元格

2. 对齐方式

-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

效果：

左对齐	右对齐	居中对齐
单元格111	单元格222	单元格333
单元格	单元格	单元格

2 进阶语法

2.1 Markdown 公式

返回目录
在编辑器中插入数学公式时，可以使用一个或两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。

表示行内公式: $E = m c^2 $
表示整行公式: $$E = m c^2$$

效果：
表示行内公式: $E = m c^2 $
表示整行公式: $E = m c^2$

2.2 绘图

2.2.1 画流程图

返回目录
更多流程图语法参考：流程图语法参考
1. 横向流程图

```mermaid
graph LR
A[方形] -->B(圆角)
    B --> C{条件a}
    C -->|a=1| D[结果1]
    C -->|a=2| E[结果2]
    F[横向流程图]
```

效果：

2. 竖向流程图

mermaid
graph TD
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
    F[竖向流程图]

效果：

3. 标准流程图

```mermaid
flowchat
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
```

效果：

4. 标准流程图（横向）

```mermaid
flowchat
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op
```

效果：

2.2.2 时序图

返回目录
时序图例子,-> 直线，–>虚线，->>实线箭头
1. UML简单时序图

```mermaid
sequenceDiagram
对象A->>对象B: 对象B你好吗?（请求）
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->>对象A: 我很好(响应)
对象A->>对象B: 你真的好吗？
```

效果：

2. UML时序图复杂样式

```mermaid
sequenceDiagram
Title: 标题：复杂使用
对象A->>对象B: 对象B你好吗?（请求）
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->>对象A: 我很好(响应)
对象B->>小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->>对象B: 你真的好吗？
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩
```

效果：

3. UML标准时序图

```mermaid

  sequenceDiagram
    participant 张三
    participant 李四
    张三->王五: 王五你好吗？
    loop 健康检查
        王五->王五: 与疾病战斗
    end
    Note right of 王五: 合理 食物 <br/>看医生...
    李四-->>张三: 很好!
    王五->李四: 你怎么样?
    李四-->王五: 很好!
```

效果：

2.2.2 甘特图

返回目录

```mermaid
        gantt
        dateFormat  YYYY-MM-DD
        title 软件开发甘特图
        section 设计
        需求                      :done,    des1, 2014-01-06,2014-01-08
        原型                      :active,  des2, 2014-01-09, 3d
        UI设计                     :         des3, after des2, 5d
    未来任务                     :         des4, after des3, 5d
        section 开发
        学习准备理解需求                      :crit, done, 2014-01-06,24h
        设计框架                             :crit, done, after des2, 2d
        开发                                 :crit, active, 3d
        未来任务                              :crit, 5d
        耍                                   :2d
        section 测试
        功能测试                              :active, a1, after des3, 3d
        压力测试                               :after a1  , 20h
        测试报告                               : 48h
```

效果：

2.3 任务列表

- [ ] 任务一 未做任务 `- + 空格 + [ ]`
- [x] 任务二 已做任务 `- + 空格 + [x]`

效果：

任务一未做任务
任务二已做任务

3 常用技巧

返回目录

3.1 快捷键

功能	快捷键
加粗	Ctrl + B
斜体	Ctrl + I
引用	Ctrl + Q
插入链接	Ctrl + L
插入代码	Ctrl + K
插入图片	Ctrl + G
提升标题	Ctrl + H
有序列表	Ctrl + O
无序列表	Ctrl + U
横线	Ctrl + R
撤销	Ctrl + Z
重做	Ctrl + Y

4 拓展

Markdown语法有时无法满足使用要求，这时就需要对其进行扩展。Markdown 支持直接写 HTML，让扩展变得简单。不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。目前支持的 HTML 元素有：<kbd> 等。

使用<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd>重启电脑

效果：
使用 Ctrl+Alt+Del 重启电脑

4.1 常用功能

4.1.1 锚点：实现跳转

返回目录
方式1
通过锚点<a>…</a>导航到指定位置可以方便文章的阅读，但是Markdown没有提供这样的语法。定义一个导航到文章具体目标的链接，需要通过 HTML 实现。
Reference：href

导航到的指定位置<a name="content"></a>
在文章指定位置添加跳转链接<a href="#content">返回文章目录</a>。

效果：
在文章指定位置添加跳转链接返回文章目录。
方式2

导航到的指定位置<div id="index"></div>
在文章指定位置添加跳转链接<a href="#content">返回目录</a>。

效果：
在文章指定位置添加跳转链接返回目录。

4.1.2 背景色

<table><tr><td bgcolor=orange>背景色是：orange</td></tr></table>

效果：

背景色是：orange

4.2 文本相关

4.2.1 注释

返回目录
“内容” 左右各留一个英文空格。

<!-- 注释内容不显示 -->

效果：

4.2.2 脚注

返回目录
Markdown 规定了脚注的语法，但有些转换工具并不支持，此时可以用 HTML 实现。

上脚标：致星空<sup>1</sup> 的Markdown语法<sup>2</sup> 博客。
下脚标：致星空<sub>1</sub> 的Markdown语法<sub>2</sub> 博客。
1. CSDN账号。
2. 标记语言。

效果：
上脚标：致星空¹ 的Markdown语法² 博客。
下脚标：致星空₁ 的Markdown语法₂ 博客。

CSDN账号。
标记语言。

4.2.3 文本高亮

<mark>致星空</mark>的Markdown语法

效果：
致星空的Markdown语法

4.2.4 文字注音

致星空之宠物<ruby>饕餮 <rt>tāo tiè</rt></ruby>

效果：
致星空之宠物饕餮 tāo tiè

4.2.5 字体、字号、颜色

返回目录
Markdown本身不支持字体、字号、颜色的设置，需要借助HTML实现。

<font face="黑体">我是黑体字</font>
<font face="微软雅黑">我是微软雅黑</font>
<font face="STCAIYUN">我是华文彩云</font>
<font color=#0099ff size=12 face="黑体">黑体</font>
<font color=gray size=5>gray</font>
<font color=#00ffff size=3>null</font>

效果：
我是黑体字
我是微软雅黑
我是华文彩云
黑体
gray
null

4.2.6 改变字号

返回目录

<big>加大字号</big>
<small>减小字号</small>

效果：
加大字号
减小字号

4.3 其他

4.3.1 首行缩进和空格

返回目录
使用占位符实现首行缩进，不同特殊占位符所占空白不一样大。

致星空 &emsp;或&#8195; //全角em space
致星空 &ensp;或&#8194; //半角en space
致星空 &nbsp;或&#160;  //半角之半角no-break space

效果：
致星空或 //全角
致星空或 //半角
致星空或 //半角之半角

4.3.2 对齐方式

返回目录

<center>行中心对齐</center>
<p align="left">行左对齐</p>
<p align="right">行右对齐</p>

效果：

行中心对齐

行左对齐

行右对齐

4.3.3 分页

用 Markdown 撰写各种文档（如PDF）时需要补充一个符号用于标识分页，以更好的组织页面内容。分页不会被渲染到页面中。

<!---->

4.3.4 分栏

返回目录

<div style="columns: 2;">
北国风光，千里冰封，万里雪飘。
望长城内外，惟余莽莽；大河上下，顿失滔滔。
山舞银蛇，原驰蜡象，欲与天公试比高。
须晴日，看红装素裹，分外妖娆。
江山如此多娇，引无数英雄竞折腰。
惜秦皇汉武，略输文采；唐宗宋祖，稍逊风骚。
一代天骄，成吉思汗，只识弯弓射大雕。
俱往矣，数风流人物，还看今朝。
</div>

效果：

北国风光，千里冰封，万里雪飘。望长城内外，惟余莽莽；大河上下，顿失滔滔。山舞银蛇，原驰蜡象，欲与天公试比高。须晴日，看红装素裹，分外妖娆。江山如此多娇，引无数英雄竞折腰。惜秦皇汉武，略输文采；唐宗宋祖，稍逊风骚。一代天骄，成吉思汗，只识弯弓射大雕。俱往矣，数风流人物，还看今朝。

参考

[1]https://www.runoob.com/markdown/md-tutorial.html

返回目录

Markdown 致星空：脚注 ↩︎

致星空

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
一文了解Markdown语法

一文了解Markdown语法目录 {#index}文章目录一文了解Markdown语法目录 {#index}0 前言1 基本语法1.1 标题我展示的是一级标题我展示的是二级标题一级标题二级标题三级标题四级标题五级标题六级标题1.2 文字编辑1.2.1 文字斜体、粗体1.2.2 文字删除线1.2.3 文字下划线1.3 段落1.4 分隔线1.5 列表1.6 区块或引用1.7 代码段1.8 脚注1.9 链接1.9.1 链接1.9.2 锚点（页内超链接）1.10 图片1.11 转义字符1.12 生成目录1.
复制链接

扫一扫

专栏目录