Markdown
Markdown是一种轻量级标记语言,排版语法简洁,让人们更多地关注内容本身而非排版。它使用易读易写的纯文本格式编写文档,可与HTML混编,可导出 HTML、PDF 以及本身的 .md 格式的文件。因简洁、高效、易读、易写,Markdown被大量使用,如Github、Wikipedia、简书等。
Markdown基础语法
标题语法
要创建标题,可在句子或单词前加“#”号,“#”号的多少代表标题的等级。
如
#### 四级标题
将显示成四级标题
tips
最好在#
和标题之间加一个空格,以方便兼容
段落语法
要创建段落,请使用空白行将一行或多行文本进行分隔。
tips
不要用空格(spaces)或制表符( tabs)缩进段落。
✅ Do this | ❌ Don’t do this |
---|---|
Don't put tabs or spaces in front of your paragraphs. |
This can result in unexpected formatting problems. Don't add tabs or spaces in front of paragraphs. |
换行语法
在一行的末尾添加两个或多个空格,然后按回车键,即可创建一个换行(<br>
)
tips
几乎每个 Markdown 应用程序都支持两个或多个空格进行换行,称为 结尾空格(trailing whitespace)
的方式,但这是有争议的,因为很难在编辑器中直接看到空格,并且很多人在每个句子后面都会有意或无意地添加两个空格。由于这个原因,你可能要使用除结尾空格以外的其它方式来换行。幸运的是,几乎每个 Markdown 应用程序都支持另一种换行方式:HTML 的 <br>
标签。
为了兼容性,请在行尾添加“结尾空格”或 HTML 的 <br>
标签来实现换行。
还有两种其他方式我并不推荐使用。CommonMark 和其它几种轻量级标记语言支持在行尾添加反斜杠 (\
) 的方式实现换行,但是并非所有 Markdown 应用程序都支持此种方式,因此从兼容性的角度来看,不推荐使用。并且至少有两种轻量级标记语言支持无须在行尾添加任何内容,只须键入回车键(return
)即可实现换行。
强调语法
要强调时,可用粗体
或斜体
两种方式,也可同时加粗加斜,**粗体**
渲染成粗体*斜体*
渲染成斜体***粗加斜***
渲染成粗加斜
tips
虽然还有其他的方式进行强调,但为了兼容考虑,最好使用加*
号的方法
引用语法
要创建块引用,请在段落前添加一个 >
符号。
1 | > Dorothy followed her through many of the beautiful rooms in her castle. |
渲染效果如下所示:
Dorothy followed her through many of the beautiful rooms in her castle.
多个段落的块引用
块引用可以包含多个段落。为段落之间的空白行添加一个 >
符号。
1 | > Dorothy followed her through many of the beautiful rooms in her castle. |
渲染效果如下:
Dorothy followed her through many of the beautiful rooms in her castle.
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
嵌套块引用
块引用可以嵌套。在要嵌套的段落前添加一个 >>
符号。
1 | > Dorothy followed her through many of the beautiful rooms in her castle. |
渲染效果如下:
Dorothy followed her through many of the beautiful rooms in her castle.
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
带有其它元素的块引用
块引用可以包含其他 Markdown 格式的元素。并非所有元素都可以使用,你需要进行实验以查看哪些元素有效。
1 | > #### The quarterly results look great! |
渲染效果如下:
The quarterly results look great!
- Revenue was off the chart.
- Profits were higher than ever.
Everything is going according to plan.
列表语法
将多个条目组织成有序或无序列表
有序列表
创建有序列表,只需在数字后面加上英文句点即可,数字也无需按顺序排列,只需以1起始,如
1 | 1. |
将显示成
第一项
第二项
第三项
无序列表
创建一个无序列表,只需在每个列表项前加-
,*
或+
即可,如
1 | - one |
将显示成
- one
- two
- three
嵌套列表
在列表中,除了文字,我们还能插入其他的东西,只需在其之前添加四个空格键或者一个tab
键即可。
如文字
1 | 1. first thing |
将表示成
- first thing
- second thing
the other thing - third thing
引用块
1 | 1. first thing |
将表示成
- first thing
- second thing
the other thing
- third thing
代码块(通常需要添加8个空格或2个tab
键)
1 | 1. Open the file. |
将表示成
Open the file.
Find the following code block on line 21:
<html> <head> <title>Test</title> </head>
Update the title to match the name of your website.
代码语法
如果想将单词或语段显示成代码,可将其包含在反引号(`)中。
如
1 | `word` |
将表示成word
转义反引号
如果想让代码中出现反引号,可以将这段代码用双反引号包裹。
如
1 | ``这是一个带`的代码`` |
将表示成这是一个带`的代码
代码块
如果想创建一个代码块,可以将代码的每一行至少缩进四个空格或一个tab
键
如
1 | include <stdio.h> |
将表示成
include <stdio.h>
int main()
{
printf(“Hello World!”);
return 0;
}
这种方法除了在列表中使用之外可能有些麻烦,所以我们还可以将代码块包裹在三个反引号或者三个波浪号之间来创建代码块。
如
1 | ~~~ |
将表示成
1 | 代码 |
分割线语法
要添加一条分割线,只需使用三个星号(***
)、破折号(---
)或者下划线(___
)即可,渲染结果如下,
tips
为了兼容性,我们需要在分割线上下添加空白行。
链接语法
要添加链接,链接文本放在中括号内,链接地址放在后面的括号中,链接title可选。
超链接Markdown语法代码:[超链接显示名](超链接地址 "超链接title")
,如
1 | 这是一个链接 [Markdown语法](https://markdown.com.cn)。 |
渲染效果如下:
这是一个链接 Markdown语法。
给链接增加title
链接title是鼠标悬停在链接上时将出现的文字,要增加这样的效果,我们只需在链接后用引号添加链接title,同时用空格将两者分隔。
如
1 | 链接 [Markdown语法](https://markdown.com.cn "come on, try out!")。 |
将渲染成:
链接 Markdown语法。
网址和email地址
将url和email地址用尖括号包裹即可将其变为链接。如
1 | <https://hzx-sparkle.github.io/> |
将渲染成
https://hzx-sparkle.github.io/
2841287903@qq.com
带格式化的链接
使链接带上强调,加斜,代码块等效果,与正常文本没有什么区别,只是需要注意一点,即变成代码块时,需要在方括号里加反引号。
1 | I love supporting the **[EFF](https://eff.org)**. |
将渲染成
I love supporting the EFF.
This is the Markdown Guide.
See the section on code
.
tips
为了更好的兼容,尽量用%20代替空格。
✅ Do this | ❌ Don’t do this |
---|---|
[link](https://www.example.com/my%20great%20page) |
[link](https://www.example.com/my great page) |
图片语法
要添加图像,请使用感叹号 (!
), 然后在方括号增加替代文本,图片链接放在圆括号里,括号里的链接后可以增加一个可选的图片标题文本。
插入图片Markdown语法代码:![图片alt](图片链接 "图片title")
。
1 | ![avatar](https://cdn.staticaly.com/gh/HZX-sparkle/image-hosting@master/20221108/avatar.46usqyain9s0.webp "avatar") |
渲染效果如下,
图片链接
给图片增加链接,可将图像的Markdown 括在方括号中,然后将链接添加在圆括号中。
1 | [![这是图片](E:\20220\Pictures\Saved Pictures\logo1.png "logo")](https://hzx-sparkle.github.io/) |
渲染效果如下,
![这是图片](E:\20220\Pictures\Saved Pictures\logo1.png “logo”)
转义字符语法
要显示原本用于格式化 Markdown 文档的字符,请在字符前面添加反斜杠字符 \ 。
1 | \* Without the backslash, this would be a bullet in an unordered list. |
渲染效果如下:
* Without the backslash, this would be a bullet in an unordered list.
可做转义的字符
以下列出的字符都可以通过使用反斜杠字符从而达到转义目的。
Character | Name |
---|---|
\ | backslash |
` | backtick (see also escaping backticks in code) |
* | asterisk |
_ | underscore |
{ } | curly braces |
[ ] | brackets |
( ) | parentheses |
# | pound sign |
+ | plus sign |
- | minus sign (hyphen) |
. | dot |
! | exclamation mark |
| | pipe (see also escaping pipe in tables) |
- Post title:Markdown学习日记
- Post author:Sparkle
- Create time:2022-11-08 20:20:52
- Post link:2022/11/08/My-First-Post/
- Copyright Notice:All articles in this blog are licensed under BY-NC-SA unless stating additionally.