Markdown
基本语法
标题
- 使用#的数量来表示标题的级别,要在#和标题名之间加入空格
- 使用HTML语法
<hn>
(n为标题的级别数),例如用<h3>
表示三级标题 - 在文本下方加入任意数量的==来表示一级标题,–来表示二级标题
段落
- 使用空白行将文本分隔
- 不能使用空格或制表符缩进段落
换行
- 使用两个及以上的结尾空格
- 使用HTML语法
<br>
- 两种不推荐的方式:兼容性差
- 反斜杠\
- 回车键
强调
- 斜体
- 在需要使用斜体的部分两端加上一个*
- 粗体
- 在需要加粗的部分两端加上两个*,支持段中加粗
- 两个下划线,只能__加粗一个整体__
- 斜体+粗体
- 在需要使用***粗体+斜体**的部分两端加上三个
引用
要创建块引用,在段落前加>符号
多个段落的引用,要在中间的空白行上也加上>符号
块引用可以嵌套,使用两个或以上>>符号
- 块引用可以包含其他Markdown格式的元素,但不是所有的都支持
列表
- 有序列表:数字+英文句点,
- 从1起始,但无需按数学顺序排列,
- 需要添加在序号和文字间添加空格。
- 使用缩进实现多级列表
- 部分编辑器支持数字+英文括号写法,不推荐使用
-
无序列表
-
使用破折号-、星号*、加号+
- 通过缩进创建多级列表
-
这样同一个表里使用多个符号的方法是错误的~
可以在列表里缩进四个空格或一个制表符,来添加其他元素
-
代码段本身需要缩进四个空格或一个制表符,在列表里则要缩进八个空格或两个制表符。注意使用空行分割列表和代码段
<html> <head> <title>Test</title> </head>
-
代码
使用`包裹代码段
分隔线
单独一行上使用三个及以上***、—、___(一篇文档内尽量统一使用一种表示形式),
且不能包含其他内容
为保证兼容性,分隔符前后需要加上空白行
链接
[超链接显示名](超链接地址 "超链接title")
HyperLink
给链接增加 Title
链接title是当鼠标悬停在链接上时会出现的文字,这个title是可选的,它放在圆括号中链接地址后面,跟链接地址之间以空格分隔
网址和Email地址
使用尖括号可以很方便地把URL或者email地址变成可点击的链接https://markdown.com.cn/
带格式化的链接
强调链接, 在链接语法前后增加星号。 要将链接表示为代码,请在方括号中添加反引号。
尽量使用%20代替URL中的空格
引用类型链接
引用样式链接是一种特殊的链接,它使URL在Markdown中更易于显示和阅读。参考样式链接分为两部分:与文本保持内联的部分以及存储在文件中其他位置的部分,以使文本易于阅读。
链接的第一部分格式
引用类型的链接的第一部分使用两组括号进行格式设置。第一组方括号包围应显示为链接的文本。第二组括号显示了一个标签,该标签用于指向您存储在文档其他位置的链接。
尽管不是必需的,可以在第一组和第二组括号之间包含一个空格。第二组括号中的标签不区分大小写,可以包含字母,数字,空格或标点符号。
以下示例格式对于链接的第一部分效果相同:
[hobbit-hole][1]
[hobbit-hole] [1]
链接的第二部分格式
引用类型链接的第二部分使用以下属性设置格式:
- 放在括号中的标签,其后紧跟一个冒号和至少一个空格(例如[label]:)。
- 链接的URL,可以选择将其括在尖括号中。
- 链接的可选标题,可以将其括在双引号,单引号或括号中。
以下示例格式对于链接的第二部分效果相同:
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle "Hobbit lifestyles"
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle 'Hobbit lifestyles'
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle (Hobbit lifestyles)
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> "Hobbit lifestyles"
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> 'Hobbit lifestyles'
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> (Hobbit lifestyles)
可以将链接的第二部分放在Markdown文档中的任何位置。有些人将它们放在出现的段落之后,有些人则将它们放在文档的末尾(例如尾注或脚注)。
图片
`![图片alt](图片链接 "图片title")`
转义字符
要显示原本用于格式化 Markdown 文档的字符,请在字符前面添加反斜杠字符 ()
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-IAPhn6Mx-1635843493553)(Markdown_Character.png)]
内嵌HTML标签
对于 Markdown 涵盖范围之外的标签,都可以直接在文件里面用 HTML 本身。如需使用 HTML,不需要额外标注这是 HTML 或是 Markdown,只需 HTML 标签添加到 Markdown 文本中即可
行级内联标签
HTML 的行级內联标签如 <span>、<cite>、<del>
不受限制,可以在 Markdown 的段落、列表或是标题里任意使用。依照个人习惯,甚至可以不用 Markdown 格式,而采用 HTML 标签来格式化。例如:如果比较喜欢 HTML 的 <a>
或<img>
标签,可以直接使用这些标签,而不用 Markdown 提供的链接或是图片语法。当你需要更改元素的属性时(例如为文本指定颜色或更改图像的宽度),使用 HTML 标签更方便些。
HTML 行级內联标签和区块标签不同,在內联标签的范围内, Markdown 的语法是可以解析的`
区块标签
区块元素──比如 <div>、<table>、<pre>、<p>
等标签,必须在前后加上空行,以便于内容区分。而且这些元素的开始与结尾标签,不可以用 tab 或是空白来缩进。Markdown 会自动识别这区块元素,避免在区块标签前后加上没有必要的<p>
标签。
请注意,Markdown 语法在 HTML 区块标签中将不会被进行处理。例如,你无法在 HTML 区块内使用 Markdown 形式的*强调*
拓展语法
表格
要添加表,请使用三个或多个连字符(—)创建每列的标题,并使用管道( | 字符,或使用HTML字符代码|
)分隔每列。您可以选择在表的任一端添加管道
表格 | |
---|---|
--- | | |
Tip: 使用连字符和管道创建表可能很麻烦。为了加快该过程,请尝试使用Markdown Tables Generator。使用图形界面构建表,然后将生成的Markdown格式的文本复制到文件中。
对齐
您可以通过在标题行中的连字符的左侧,右侧或两侧添加冒号(:),将列中的文本对齐到左侧,右侧或中心。
visual studio | markdown |
---|---|
--- | | |
格式化表格中的文字
您可以在表格中设置文本格式。例如,您可以添加链接,代码(仅反引号(`)中的单词或短语,而不是代码块)和强调。
您不能添加标题,块引用,列表,水平规则,图像或HTML标签
围栏代码块
在代码块之前和之后的行上使用三个反引号(```)或三个波浪号(~~~)
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
语法高亮
许多Markdown处理器都支持受围栏代码块的语法突出显示。使用此功能,您可以为编写代码的任何语言添加颜色突出显示。要添加语法突出显示,请在受防护的代码块之前的反引号旁边指定一种语言
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
标题编号
许多Markdown处理器支持标题的自定义ID - 一些Markdown处理器会自动添加它们。添加自定义ID允许您直接链接到标题并使用CSS对其进行修改。要添加自定义标题ID,请在与标题相同的行上用大括号括起该自定义ID。
指定一种语言
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
标题编号
许多Markdown处理器支持标题的自定义ID - 一些Markdown处理器会自动添加它们。添加自定义ID允许您直接链接到标题并使用CSS对其进行修改。要添加自定义标题ID,请在与标题相同的行上用大括号括起该自定义ID。