MarkDown语法记录

MarkDown语法记录

Markdown的标题语法

1. 创建标题需在单词或短语前面添加井号 (#)。# 的数量代表了标题的级别。例如：### My Header
2. 还可以在文本下方添加任意数量的 == 号来标识一级标题，或者 – 号来标识二级标题。
   例如：
   Heading level 1
   ==============
3. 不同的 Markdown 应用程序处理 # 和标题之间的空格方式并不一致。为了兼容考虑，请用一个空格在 # 和标题之间进行分隔。

Here’s a Heading正确

#Here’s a Heading可能错误

段落语法

要创建段落，请使用空白行将一行或多行文本进行分隔。
例如：
I really like using Markdown.

I think I’ll use it to format all of my documents from now on.

实践：

不要用空格（spaces）或制表符（ tabs）缩进段落。
Don’t put tabs or spaces in front of your paragraphs.

Keep lines left-aligned like this.
而不是
This can result in unexpected formatting problems.

Don’t add tabs or spaces in front of paragraphs.

Markdown 换行语法

在一行的末尾添加两个或多个空格，然后按回车键,即可创建一个换行(
)。
eg:
This is the first line.
And this is the second line.

换行（Line Break）用法的最佳实践

几乎每个 Markdown 应用程序都支持两个或多个空格进行换行，称为 结尾空格（trailing whitespace) 的方式，但这是有争议的，因为很难在编辑器中直接看到空格，并且很多人在每个句子后面都会有意或无意地添加两个空格。由于这个原因，你可能要使用除结尾空格以外的其它方式来换行。幸运的是，几乎每个 Markdown 应用程序都支持另一种换行方式：HTML 的
标签。
为了兼容性，请在行尾添加“结尾空格”或 HTML 的
标签来实现换行。
还有两种其他方式我并不推荐使用。CommonMark 和其它几种轻量级标记语言支持在行尾添加反斜杠 () 的方式实现换行，但是并非所有 Markdown 应用程序都支持此种方式，因此从兼容性的角度来看，不推荐使用。并且至少有两种轻量级标记语言支持无须在行尾添加任何内容，只须键入回车键（return）即可实现换行

正确	不正确
First line with two spaces after. And the next line. First line with the HTML tag after. And the next line. First line with a backslash after. And the next line.	First line with nothing after. And the next line.

Markdown 强调语法

粗体（Bold）

要加粗文本，请在单词或短语的前后各添加两个星号（asterisks）或下划线（underscores）。如需加粗一个单词或短语的中间部分用以表示强调的话，请在要加粗部分的两侧各添加两个星号（asterisks）。

粗体（Bold）用法最佳实践

Markdown 应用程序在如何处理单词或短语中间的下划线上并不一致。为兼容考虑，在单词或短语中间部分加粗的话，请使用星号（asterisks）。

正确	不推荐
Loveisbold	Love__is__bold

斜体（Italic）

要用斜体显示文本，请在单词或短语前后添加一个星号（asterisk）或下划线（underscore）。要斜体突出单词的中间部分，请在字母前后各添加一个星号，中间不要带空格。

Marldown语法	Html	预览效果
Italicized text is the cat’s meow.	Italicized text is the cat’s meow.	Italicized text is the cat’s meow.
Italicized text is the cat’s meow.	Italicized text is the cat’s meow.	Italicized text is the cat’s meow.
Acatmeow	Acatmeow	Acatmeow

斜体（Italic）用法的最佳实践

要同时用粗体和斜体突出显示文本，请在单词或短语的前后各添加三个星号或下划线。要加粗并用斜体显示单词或短语的中间部分，请在要突出显示的部分前后各添加三个星号，中间不要带空格。

✅ Do this	❌ Don’t do this
Acatmeow	A_cat_meow

粗体（Bold）和斜体（Italic）

要同时用粗体和斜体突出显示文本，请在单词或短语的前后各添加三个星号或下划线。要加粗并用斜体显示单词或短语的中间部分，请在要突出显示的部分前后各添加三个星号，中间不要带空格。

Markdown语法	HTML	预览效果
This text is really important.	This text is really important.	This text is really important.
This text is really important.	This text is really important.	This text is really important.
This text is really important.	This text is really important.	This text is really important.
This text is really important.	This text is really important.	This text is really important.
This is reallyveryimportant text.	This is reallyveryimportant text.	This is reallyveryimportant text.

粗体（Bold）和斜体（Italic）用法的最佳实践

Markdown 应用程序在处理单词或短语中间添加的下划线上并不一致。为了实现兼容性，请使用星号将单词或短语的中间部分加粗并以斜体显示，以示重要。

✅ Do this	❌ Don’t do this
This is reallyveryimportant text.	This is really___very___important text.

Markdown 引用语法

要创建块引用，请在段落前添加一个 > 符号。即：

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.

嵌套块引用

块引用可以嵌套。在要嵌套的段落前添加一个 >> 符号。即：

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 格式的元素。并非所有元素都可以使用，你需要进行实验以查看哪些元素有效。

The quarterly results look great!

• Revenue was off the chart.
• Profits were higher than ever.

Everything is going according to plan.

Markdown 列表语法

可以将多个条目组织成有序或无序列表。

有序列表

要创建有序列表，请在每个列表项前添加数字并紧跟一个英文句点。数字不必按数学顺序排列，但是列表应当以数字 1 起始。

1. First item
2. Second item
3. Third item
4. Fourth item

---

1. First item
2. Second item
3. Third item
4. Fourth item

---

1. First item
2. Second item
3. Third item
4. Fourth item

---

1. First item
2. Second item
3. Third item
   1. Indented item
   2. Indented item
4. Fourth item

有序列表最佳实践

CommonMark and a few other lightweight markup languages let you use a parenthesis ()) as a delimiter (e.g., 1) First item), but not all Markdown applications support this, so it isn’t a great option from a compatibility perspective. For compatibility, use periods only.
CommonMark 和一些其他的轻量级标记语言让您可以使用括号（）作为定界符（例如，1）第一项），但并非所有 Markdown 应用程序都支持这一点，因此，从兼容性的角度来看，这不是一个很好的选择。为了兼容性，只使用句点。

1. First item
2. Second item

1. First item
2. Second item

无序列表

要创建无序列表，请在每个列表项前面添加破折号 (-)、星号 (*) 或加号 (+) 。缩进一个或多个列表项可创建嵌套列表。

• First item
• Second item
• Third item
• Fourth item

---

• First item
• Second item
• Third item
• Fourth item

---

• First item
• Second item
• Third item
• Fourth item

---

• First item
• Second item
• Third item
  • Indented item
  • Indented item
• Fourth item

---

• First item

• Second item

• Third item
  • Indented item

无序列表最佳实践

Markdown applications don’t agree on how to handle different delimiters in the same list. For compatibility, don’t mix and match delimiters in the same list — pick one and stick with it.
即不要混用破折号 (-)、星号 (*) 或加号 (+)

在列表中嵌套其他元素

要在保留列表连续性的同时在列表中添加另一种元素，请将该元素缩进四个空格或一个制表符，如下例所示：

段落

• This is the first list item.

• Here’s the second list item.

  I need to add another paragraph below the second list item.

• And here’s the third list item.

引用块

• This is the first list item.

• Here’s the second list item.

  A blockquote would look great below the second list item.

• And here’s the third list item.

代码块

1. Open the file.

2. Find the following code block on line 21:

   <html>
     <head>
       <title>Test</title>
     </head>
   

3. Update the title to match the name of your website.

图片

1. Open the file containing the Linux mascot.

2. Marvel at its beauty.

   

3. Close the file.

列表

You can nest an unordered list in an ordered list, or vice versa.
有序列表和无序列表的相互嵌套

1. First item
2. Second item
3. Third item
   • Indented item
   • Indented item
4. Fourth item

Markdown 代码语法

要将单词或短语表示为代码，请将其包裹在反引号 (`) 中。

Marldown语法	Html	预览效果
At the command prompt, type nano.	At the command prompt, type nano.	At the command prompt, type nano.

转义反引号

如果你要表示为代码的单词或短语中包含一个或多个反引号，则可以通过将单词或短语包裹在双反引号(``)中

Marldown语法	Html	预览效果
Use `code` in your Markdown file.	Use code in your Markdown file. Use code in your Markdown file.	Use code in your Markdown file.

代码块

要创建代码块，请将代码块的每一行缩进至少四个空格或一个制表符。




Note: 要创建不用缩进的代码块，请使用 围栏式代码块（fenced code blocks）.
Markdown基本语法允许您通过将行缩进四个空格或一个制表符来创建代码块。如果发现不方便，请尝试使用受保护的代码块。根据Markdown处理器或编辑器的不同，您将在代码块之前和之后的行上使用三个反引号（(```）或三个波浪号（~~~）。

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

语法高亮:
许多Markdown处理器都支持受围栏代码块的语法突出显示。使用此功能，您可以为编写代码的任何语言添加颜色突出显示。要添加语法突出显示，请在受防护的代码块之前的反引号旁边指定一种语言。

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

Markdown 分隔线语法

要创建分隔线，请在单独一行上使用三个或多个星号 ()*、破折号 (—) 或 下划线 (___) ，并且不能包含其他内容。

---

---

---

三种效果一致

分隔线（Horizontal Rule）用法最佳实践

为了兼容性，请在分隔线的前后均添加空白行。
ry to put a blank line before…

---

…and after a horizontal rule.

Markdown 链接语法

链接文本放在中括号内，链接地址放在后面的括号中，链接title可选。
超链接Markdown语法代码：超链接显示名
对应的HTML代码：超链接显示名
这是一个链接 Markdown语法。

给链接增加 Title

链接title是当鼠标悬停在链接上时会出现的文字，这个title是可选的，它放在圆括号中链接地址后面，跟链接地址之间以空格分隔。
这是一个链接 Markdown语法。

网址和Email地址

使用尖括号可以很方便地把URL或者email地址变成可点击的链接。
https://markdown.com.cn
fake@example.com

带格式化的链接

强调 链接, 在链接语法前后增加星号。 要将链接表示为代码，请在方括号中添加反引号。
I love supporting the EFF.
This is the Markdown Guide.
See the section on code.

引用类型链接

引用样式链接是一种特殊的链接，它使URL在Markdown中更易于显示和阅读。参考样式链接分为两部分：与文本保持内联的部分以及存储在文件中其他位置的部分，以使文本易于阅读。

链接的第一部分格式

引用类型的链接的第一部分使用两组括号进行格式设置。第一组方括号包围应显示为链接的文本。第二组括号显示了一个标签，该标签用于指向您存储在文档其他位置的链接。
尽管不是必需的，可以在第一组和第二组括号之间包含一个空格。第二组括号中的标签不区分大小写，可以包含字母，数字，空格或标点符号。
[hobbit-hole][1]
[hobbit-hole] [1]

链接的第二部分格式

引用类型链接的第二部分使用以下属性设置格式：

1. 放在括号中的标签，其后紧跟一个冒号和至少一个空格（例如[label]:）。
2. 链接的URL，可以选择将其括在尖括号中。
3. 链接的可选标题，可以将其括在双引号，单引号或括号中。
   以下示例格式对于链接的第二部分效果相同：
   [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 应用程序处理URL中间的空格方式不一样。为了兼容性，请尽量使用%20代替空格。

使用%20代替空格

Markdown 图片语法

要添加图像，请使用感叹号 (!), 然后在方括号增加替代文本，图片链接放在圆括号里，括号里的链接后可以增加一个可选的图片标题文本。
插入图片Markdown语法代码：。
对应的HTML代码：

链接图片

给图片增加链接，请将图像的Markdown 括在方括号中，然后将链接添加在圆括号中。

Markdown 转义字符语法

要显示原本用于格式化 Markdown 文档的字符，请在字符前面添加反斜杠字符 \ 。
* 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)

特殊字符自动转义

在 HTML 文件中，有两个字符需要特殊处理： < 和 & 。 < 符号用于起始标签，& 符号则用于标记 HTML 实体，如果你只是想要使用这些符号，你必须要使用实体的形式，像是 < 和 &。

& 符号其实很容易让写作网页文件的人感到困扰，如果你要打「AT&T」 ，你必须要写成「AT&T」 ，还得转换网址内的 & 符号，如果你要链接到：
http://images.google.com/images?num=30&q=larry+bird
你必须要把网址转成：
http://images.google.com/images?num=30&q=larry+bird
才能放到链接标签的 href 属性里。不用说也知道这很容易忘记，这也可能是 HTML 标准检查所检查到的错误中，数量最多的。

Markdown 允许你直接使用这些符号，它帮你自动转义字符。如果你使用 & 符号的作为 HTML 实体的一部分，那么它不会被转换，而在其它情况下，它则会被转换成 &。所以你如果要在文件中插入一个著作权的符号，你可以这样写：

©
Markdown 将不会对这段文字做修改，但是如果你这样写：

AT&T
Markdown 就会将它转为：

AT&T
类似的状况也会发生在 < 符号上，因为 Markdown 支持 行内 HTML ，如果你使用 < 符号作为 HTML 标签的分隔符，那 Markdown 也不会对它做任何转换，但是如果你是写：

4 < 5
Markdown 将会把它转换为：

4 < 5
需要特别注意的是，在 Markdown 的块级元素和内联元素中， < 和 & 两个符号都会被自动转换成 HTML 实体，这项特性让你可以很容易地用 Markdown 写 HTML。（在 HTML 语法中，你要手动把所有的 < 和 & 都转换为 HTML 实体。）

Markdown 内嵌 HTML 标签

对于 Markdown 涵盖范围之外的标签，都可以直接在文件里面用 HTML 本身。如需使用 HTML，不需要额外标注这是 HTML 或是 Markdown，只需 HTML 标签添加到 Markdown 文本中即可。

行级內联标签

HTML 行级內联标签和区块标签不同，在內联标签的范围内， Markdown 的语法是可以解析的。
This word is bold. This word is italic.

区块标签

区块元素──比如

、、

、
 等标签，必须在前后加上空行，以便于内容区分。而且这些元素的开始与结尾标签，不可以用 tab 或是空白来缩进。Markdown 会自动识别这区块元素，避免在区块标签前后加上没有必要的 
 标签。

Markdown 扩展语法

Markdown表格

要添加表，请使用三个或多个连字符（—）创建每列的标题，并使用管道（|）分隔每列。您可以选择在表的任一端添加管道。

Syntax	Description
Header	Title
Paragraph	Text

单元格宽度可以变化，如下所示。呈现的输出将看起来相同

Syntax	Description
Header	Title
Paragraph	Text

Tip: 使用连字符和管道创建表可能很麻烦。为了加快该过程，请尝试使用Markdown Tables Generator。使用图形界面构建表，然后将生成的Markdown格式的文本复制到文件中。

对齐

您可以通过在标题行中的连字符的左侧，右侧或两侧添加冒号（:），将列中的文本对齐到左侧，右侧或中心。

Syntax	Description	Test Text
Header	Title	Here’s this
Paragraph	Text	And more

使用换行

使用html的源生语言：<br> or <br `/>

Syntax	Description	Test Text
Header headers	Title	Here’s this Here’s this1
Paragraph	Text	And more

格式化表格中的文字

您可以在表格中设置文本格式。例如，您可以添加链接，代码（仅反引号（`）中的单词或短语，而不是代码块）和强调。

您不能添加标题，块引用，列表，水平规则，图像或HTML标签

在表中转义管道字符

您可以使用表格的HTML字符代码（|）在表中显示竖线（|）字符。

Markdown 任务列表语法

任务列表使您可以创建带有复选框的项目列表。在支持任务列表的Markdown应用程序中，复选框将显示在内容旁边。要创建任务列表，请在任务列表项之前添加破折号-和方括号[ ]，并在[ ]前面加上空格。要选择一个复选框，请在方括号[x]之间添加 x 。

• Write the press release
• Update the website
• Contact the media

Markdown 使用 Emoji 表情

有两种方法可以将表情符号添加到Markdown文件中：将表情符号复制并粘贴到Markdown格式的文本中，或者键入emoji shortcodes。

复制和粘贴表情符号

在大多数情况下，您可以简单地从Emojipedia 等来源复制表情符号并将其粘贴到文档中。许多Markdown应用程序会自动以Markdown格式的文本显示表情符号。从Markdown应用程序导出的HTML和PDF文件应显示表情符号。

Tip: 如果您使用的是静态网站生成器，请确保将HTML页面编码为UTF-8。.

使用表情符号简码

一些Markdown应用程序允许您通过键入表情符号短代码来插入表情符号。这些以冒号开头和结尾，并包含表情符号的名称。
去露营了！:tent: ⛺️ 很快回来。

真好笑！ :joy:😂
Note: 注意：您可以使用此表情符号简码列表，但请记住，表情符号简码因应用程序而异。有关更多信息，请参阅Markdown应用程序的文档。

简码	效果
:blush:	😊
:relaxed:	☺️
:laughing:	😆
:heart_eyes:	😍
:satisfied:	😆

参考文档

Markdown官方语法
Note:此篇文档通过md编辑器上传