MarkDown语法汇总

总览

Markdown是一种轻量级的标记语言,可用于将格式设置元素添加到纯文本文档中。Markdown 由John Gruber于2004年创建,如今已成为世界上最受欢迎的标记语言之一。

标题

1. 使用#号创建标题

使用 # 创建标题可以支持6级标题。你需要几级标题就输入几个 # 号,然后再输入一个空格后,即可生成所需要的标题。

# 1级标题
## 2级标题
### 3级标题
#### 4级标题
##### 5级标题
###### 6级标题

标题显示效果1

2. 使用=和-号创建标题

使用 = 可以创建一级标题,使用-可以创建二级标题。

一级标题
========
二级标题
--------

标题显示效果图2

段落

段落直接输入文字就行了,切记行首不要带有空格 Space 或制表符 Tab

1. 换行

输入两个或两个以上空格结束一行,然后键入回车键 Enter.

2. 字体格式

*斜体字 >>就是在字的前后各添加一个星号*  
_斜体字 >>也可以在字的前后各添加一个下划线_  
**粗体字 >>就是在字的前后各添加两个星号**  
__粗体字 >>也可以在字的前后各添加两个下划线__  
***粗斜体字 >>就是在字的前后各添加三个星号***  
___粗斜体字 >>也可以在字的前后各添加三个下划线___  

段落-字体格式显示效果图

3. 删除线

可以通过在段落的字体上放置一条横线来表示“删除”,表示这是错误的或不存在。要实现该功能只需要在文字的两端添加两个波浪线 ~~ 即可。

~~世界是平坦的。~~ 我们现在知道世界是圆的。

段落-删除线显示效果图

4. 脚注

脚注使您可以添加注释和参考,而不会使文档正文混乱。创建脚注时,带有脚注引用的链接将出现带有链接的上标编号。读者可以单击链接跳至页面底部的脚注内容。

这是测试脚注[^标识符]。

这是数字脚注[^1]。这是文字脚注[^文本脚注]

[^标识符]:标识符可以是数字或文本。但不能包含空格或制表符。  
[^1]:数字脚注测试说明。  
[^文本脚注]:文本脚注测试说明。

段落-脚注显示效果图

5. 下划线

Markdown本身并没有该语法,因为会和超链接样式混淆。所以如非不要请不要添加。
但可以使用html标签来实现(u指的是underline下划线)。

<u>需要添加下划线的内容</u>

段落-下划线显示效果图

6. 首行缩进

Markdown本身并没有该语法,但可以使用下面的语法(两个&emsp;)替代传统的两个字符缩进。

&emsp;&emsp;Markdown本身并没有该语法,这只是一种非常简单的替代方法;当然Markdown语法支持html语句,可以直接用html标签来实现,请自行搜索学习。

段落-首行缩进显示效果图

7. 字体颜色、大小、字体类型

Markdown本身并没有该语法,但Markdown支持HTML的语法。

<font color="" size=4 face="">字体颜色、大小、字体类型</font>  
<font color="blue" size=3 face="楷体">这是蓝色3号楷体子</font>  
<font color="red">这是红色字体,可单独配置一项</font>  
<font size=4>这是4号字体,可单独配置一项</font>  

8. 文本高亮

Markdown本身并没有该语法,但Markdown支持HTML的语法。

不需要高亮,<mark>重点提示需要高亮显示</mark>,\<mark> 是HTML5的新标签。

段落-高亮显示

块引用

在段落的开头添加一个 > , 然后再键入一个空格。

> 块引用  
> blockquote  

段落-块引用显示效果图

1. 嵌套块引用

区块可以嵌套,在需要的段落前面再添加一个 >

> 嵌套主体  
>> 第一层嵌套  
>>> 第二层嵌套 

块引用嵌套显示效果图

2. 具有其他元素的块引用

块引用可以包含其他Markdown格式的元素。并非所有元素都可以使用-您需要进行实验以查看哪些元素有效。

> ### 在块引用中添加标题 
> 1. 在块引用添加项目编号
> 2. 在块引用添加项目编号  
> + 在块引用添加项目符号 
> - 在块引用添加项目符号 
> * 在块引用添加项目符号 
> - **粗体文本** 和 *斜体文本*

块引用添加其他元素显示效果图

列表

支持有序列表和无序列表。

1. 有序列表

只需要在前面添加添加数字和. ,然后键入空格Space。数字不必按数字顺序排列,但列表应以数字开头。

1. 第一项
2. 第二项
3. 第三项
4. 第四项
5. 第五项
6. 第六项
   1. 缩进项(键入4个空格或制表符)
   2. 缩进项(键入4个空格或制表符) 

列表-有序显示效果图

2. 无序列表

请在订单项前添加减号 -,星号 * 或加号 +

- 第一项
- 第二项
* 第三项
* 第四项
+ 第五项
+ 第六项
    + 缩进项(键入4个空格或制表符)
    - 缩进项(键入4个空格或制表符) 

列表-无序列表显示效果图

代码

要将段落中的函数或其他表达式表示为代码,请将其括在勾号 ` 中。

`main()`函数中调用`printf()`函数

代码-显示效果图

1. 代码块

要创建代码块,请在代码块的每一行缩进至少四个空格 Space 或一个制表符 Tab

for(i=0; i<8; i++) {
    printf("这是代码块测试代码");
    delay_ms(1000);                 /* 延时1s */
}

代码-代码块显示效果图

2. 围栏代码块

根据Markdown处理器或编辑器的不同,您将在代码块之前和之后的行上使用三个刻度线 ``` 或三个波浪号~~~ ;如果需要高亮显示,请指定对应的语言,诸如C、C++、JAVA、Python等等。

```
for(i=0; i<8; i++) {
    printf("这是代码块测试代码");
    delay_ms(1000);                 /* 延时1s */
}
```
```c++
for(i=0; i<8; i++) {
    printf("这是代码块测试代码");
    delay_ms(1000);                 /* 延时1s */
}
```

代码-围栏代码块显示效果图

链接

创建链接时。首先再方括号中填写链接文本(例如[链接名称]),然后再紧跟方括号的括号(例如(https://www.baidu.com/))中填写链接地址URL。

我常用的搜索引擎是[百度](https://www.baidu.com/)

链接-显示效果图

1. 为链接添加标题

您可以选择为链接添加标题。当用户将鼠标悬停在链接上时,这将显示为工具提示。要添加标题,直接在URL后面键入空格 Space 后添加标题。

我常用的搜索引擎是[百度](https://www.baidu.com/ "众里寻他千百度")。

链接-添加标题显示效果图.gif

2. 网址和电子邮件地址

要将URL或电子邮件地址快速转换为链接,请将其括在尖括号中。

<https://markdown.p2hp.com>
<xxxx@email.com>

链接-网址和电子邮件地址显示效果图.gif

3. 格式化链接

为了强调链接,请在方括号和括号之前和之后添加星号。
其实就是相当于段落中字体格式的设置。

图片

要添加图像,请在链接的前面添加感叹号(!),然后在括号中添加替代文本,并在括号中添加图像资源的路径或URL。您可以选择在括号中的URL之后添加标题。

![链接-添加标题显示效果图.gif](https://gitee.com/cynalfly/mimage/raw/master/Image/MarkDown%E8%AF%AD%E6%B3%95%E6%B1%87%E6%80%BB/%E9%93%BE%E6%8E%A5-%E6%B7%BB%E5%8A%A0%E6%A0%87%E9%A2%98%E6%98%BE%E7%A4%BA%E6%95%88%E6%9E%9C%E5%9B%BE.gif)

链接-添加标题显示效果图.gif

表格

要添加表格,请使用三个或多个连字符 创建每列的标题,并使用竖线 | 分隔每列。

| 标题 | 标题 |
| --- | -------------- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |

1. 使用图形界面创建表格

使用字符创建表格很费事、很麻烦,为了加快这一过程,我们可以使用在线表格生成器Markdown Tables Generator

表格-图形界面创建表格

2. 对齐方式

要实现类似Excel文本的左对齐、居中、右对齐,只需要在连字符的左侧、两侧、右侧添加冒号 : 即可。

| 物料编号 | 物料名称 | 物料封装 |
| :--- | :------: |----:|
| 1 | PCB板 | Main Board |
| 2 | SPC5634MF2MLQ80 | LQFP144 |

表格-对齐方式显示效果图

转义字符

Markdown使用很多字符表示特定的意思,要显示原义字符,请在字符的前面添加反斜杠 \ ,这样就可以转义字符了。

#### 没有使用反斜杠,这是4级标题
\#### 使用反斜杠,这就是4个#号

转义字符-显示效果图

1. 可以转义的字符

字符 名称
\反斜杠
`刻度线
*星号
_下划线
{}大括号
[]中括号
()括号
#井号
+加号
-减号(连字符)
.
!感叹号
|竖线

参考

[1]. Markdown指南

  • 22
    点赞
  • 110
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值