MarkDown 语法学习笔记

MarkDown 学习笔记

MarkDown 简介

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

专注于文字内容
纯文本，易读易写，可以方便地纳入版本控制
语法简单，没有什么学习成本，能轻松在码字的同时做出美观大方的排版

使用 Markdown 与使用 Word 类编辑器不同。在 Word 之类的应用程序中，单击按钮以设置单词和短语的格式，并且，更改立即可见。而 Markdown 与此不同，当你创建 Markdown 格式的文件时，可以在文本中添加 Markdown 语法，以指示哪些单词和短语看起来应该有所不同。

Markdown 语法的首要设计目标是尽可能易读。基于这个目标，Markdown 格式的文档能够以纯文本形式原样发布，而不会看起来像被填满了标签或格式化指令。

基本语法

千万不要被「标记」、「语言」吓到，Markdown的语法十分简单，常用的标记符号不超过十个，用于日常写作记录绰绰有余，不到半小时就能完全掌握。

就是这十个不到的标记符号，却能让人优雅地沉浸式记录，专注内容而不是纠结排版，达到「心中无尘，码字入神」的境界。

标题语法

一般使用“#”的数量来标记标题的级别，数量越高，级别越大，字体越小。注意在标题与“#”之间有一个空格。

MarkDown语法	HTML	效果
# Heading level 1	/ Heading level 1/	Heading level 1
## Heading level 2	/ Heading level 2/	Heading level 2
### Heading level 3	/ Heading level 3/	Heading level 3
#### Heading level 4	/ Heading level 4/	Heading level 4
##### Heading level 5	/ Heading level 5/	Heading level 5

段落语法

创建段落，使用空白行将一行或多行文本进行分隔。

不能使用空格或者Tab键进行首行缩进。

与 HTML 中对应的符号是 <p> </p>

强调语法

粗体

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

斜体

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

粗斜体

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

引用语法

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

块引用可以包含多个段落。为段落之间的空白行添加一个 > 符号。

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

块引用可以包含其他 Markdown 格式的元素，但是并非所有元素都可以使用。

列表语法

有序列表

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

无序列表

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

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

Open the file.

Hello world

Find the following code block on line 21:

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

Update the title to match the name of your website.
- MarkDown
- picture

代码语法

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

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

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

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

分隔线语法

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

链接语法

链接文本放在中括号内，链接地址放在后面的括号中，链接title可选。

超链接Markdown语法代码：

[超链接显示名](超链接地址 "超链接title")

对应的HTML代码：

<a href="超链接地址" title="超链接title">超链接显示名</a>

给链接加title

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

这是一个链接 [Markdown语法](https://markdown.com.cn "最好的markdown教程")。

渲染效果：

这是一个链接 Markdown语法。

网址和 Email 地址

使用尖括号可以很方便地把URL或者email地址变成可点击的链接。

<https://markdown.com.cn>

<fake@example.com>

渲染效果：

https://markdown.com.cn

fake@example.com

带格式的链接

强调链接, 在链接语法前后增加星号。要将链接表示为代码，请在方括号中添加反引号。截屏2022-04-09 17.52.59

引用类型链接

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

链接的第一部分格式

引用类型的链接的第一部分使用两组括号进行格式设置。第一组方括号包围应显示为链接的文本。第二组括号显示了一个标签，该标签用于指向存储在文档其他位置的链接。

尽管不是必需的，可以在第一组和第二组括号之间包含一个空格。第二组括号中的标签不区分大小写，可以包含字母，数字，空格或标点符号。

以下示例格式对于链接的第一部分效果相同：
- `[hobbit-hole][1]``
- ``[hobbit-hole] [1]`
链接的第二部分格式

引用类型链接的第二部分使用以下属性设置格式：
1. 放在括号中的标签，其后紧跟一个冒号和至少一个空格（例如[label]:）。
2. 链接的URL，可以选择将其括在尖括号中。
3. 链接的可选标题，可以将其括在双引号，单引号或括号中。
可以将链接的第二部分放在Markdown文档中的任何位置。有些人将它们放在出现的段落之后，有些人则将它们放在文档的末尾（例如尾注或脚注)。

不同的 Markdown 应用程序处理URL中间的空格方式不一样。为了兼容性，请尽量使用%20代替空格。

图片语法

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

插入图片Markdown语法代码：

![图片alt](图片链接 "图片title")。

对应的HTML代码：

<img src="图片链接" alt="图片alt" title="图片title">

链接图片

给图片增加链接，请将图像的Markdown 括在方括号中，然后将链接添加在圆括号中。
[![shiprock.c3b9a023](https://img-blog.csdnimg.cn/img_convert/f691582e7651276c97e5605cb5b7f2f4.png)](https://markdown.com.cn/basic-syntax/images.html)

转义字符语法

要显示原本用于格式化 Markdown 文档的字符，请在字符前面添加反斜杠字符\。

以下列出的字符都可以通过使用反斜杠字符从而达到转义目的:

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&amp;q=larry+bird

才能放到链接标签的 href 属性里。不用说也知道这很容易忘记，这也可能是 HTML 标准检查所检查到的错误中，数量最多的。

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

&copy;

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

AT&T

Markdown 就会将它转为：

AT&amp;T

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

4 < 5

Markdown 将会把它转换为：

4 &lt; 5

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

内嵌 HTML 标签

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

行级內联标签

HTML 的行级內联标签如 <span>、<cite>、<del> 不受限制，可以在 Markdown 的段落、列表或是标题里任意使用。依照个人习惯，甚至可以不用 Markdown 格式，而采用 HTML 标签来格式化。例如：如果比较喜欢 HTML 的 <a> 或 <img> 标签，可以直接使用这些标签，而不用 Markdown 提供的链接或是图片语法。当你需要更改元素的属性时（例如为文本指定颜色或更改图像的宽度），使用 HTML 标签更方便些。

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

This **word** is bold. This <em>word</em> is italic.

渲染效果：

This word is bold. This word is italic.

区块标签

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

例如，在 Markdown 文件里加上一段 HTML 表格：

This is a regular paragraph.

<table>
    <tr>
        <td>one</td>
    </tr>
    <tr>
        <td>two</td>
    </tr>
</table>

This is another regular paragraph.

渲染结果：

his is a regular paragraph.

one

two

This is another regular paragraph.

请注意，Markdown 语法在 HTML 区块标签中将不会被进行处理。例如，你无法在 HTML 区块内使用 Markdown 形式的*强调*。

拓展语法

hn Gruber的原始设计文档中概述的基本语法主要是为了应付大多数情况下的日常所需元素，但对于某些人来说还不够，这就是扩展语法的用武之地。

一些个人和组织开始通过添加其他元素（例如表，代码块，语法突出显示，URL自动链接和脚注）来扩展基本语法。可以通过使用基于基本Markdown语法的轻量级标记语言，或通过向兼容的Markdown处理器添加扩展来启用这些元素。

并非所有Markdown应用程序都支持扩展语法元素。需要检查的应用程序所使用的轻量级标记语言是否支持要使用的扩展语法元素。如果没有，那么仍然有可能在Markdown处理器中启用扩展。

表格

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

| Syntax      | Description |
| ----------- | ----------- |
| Header      | Title       |
| Paragraph   | Text        |

呈现的输出如下所示：

Syntax	Description
Header	Title
Paragraph	Text

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

| Syntax | Description |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |

Syntax	Description
Header	Title
Paragraph	Text

对齐

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

| Syntax      | Description | Test Text     |
| :---        |    :----:   |          ---: |
| Header      | Title       | Here's this   |
| Paragraph   | Text        | And more      |

呈现的输出如下所示：

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

格式化表格中的文字

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

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

在表中转义管道字符

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

围栏代码块

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

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

呈现的输出如下所示：

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

语法高亮

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

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

输出效果：

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

脚注

脚注使可以添加注释和参考，而不会使文档正文混乱。当创建脚注时，带有脚注的上标数字会出现在添加脚注参考的位置。读者可以单击链接以跳至页面底部的脚注内容。

要创建脚注参考，请在方括号（[^1]）内添加插入符号和标识符。标识符可以是数字或单词，但不能包含空格或制表符。标识符仅将脚注参考与脚注本身相关联-在输出中，脚注按顺序编号。

在括号内使用另一个插入符号和数字添加脚注，并用冒号和文本（[^1]: My footnote.）。不必在文档末尾添加脚注。可以将它们放在除列表，块引号和表之类的其他元素之外的任何位置。

Here's a simple footnote,[^1] and here's a longer one.[^bignote]

[^1]: This is the first footnote.

[^bignote]: Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    `{ my code }`

    Add as many paragraphs as you like.

呈现的输出如下所示：

Here's a simple footnote,^[1] and here's a longer one.^[2]

Indent paragraphs to include them in the footnote.

{ my code }

Add as many paragraphs as you like.

标题编号

许多Markdown处理器支持标题的自定义ID - 一些Markdown处理器会自动添加它们。添加自定义ID允许直接链接到标题并使用CSS对其进行修改。要添加自定义标题ID，请在与标题相同的行上用大括号括起该自定义ID。

### My Great Heading {#custom-id}

HTML看起来像这样：

<h3 id="custom-id">My Great Heading</h3>

链接到标题ID

通过创建带有数字符号（#）和自定义标题ID的[标准链接]((/basic-syntax/links.html)，可以链接到文件中具有自定义ID的标题。

Markdown	HTML	预览效果
`[Heading IDs](#heading-ids)`	`<a href="#heading-ids">Heading IDs</a>`	Heading IDs

定义列表

一些Markdown处理器允许创建术语及其对应定义的定义列表。要创建定义列表，请在第一行上键入术语。在下一行，键入一个冒号，后跟一个空格和定义。

First Term
: This is the definition of the first term.

Second Term
: This is one definition of the second term.
: This is another definition of the second term.

HTML看起来像这样：

<dl>
  <dt>First Term</dt>
  <dd>This is the definition of the first term.</dd>
  <dt>Second Term</dt>
  <dd>This is one definition of the second term. </dd>
  <dd>This is another definition of the second term.</dd>
</dl>

呈现的输出如下所示：

First Term: This is the definition of the first term.
Second Term: This is one definition of the second term.; This is another definition of the second term.

### 删除线

可以通过在单词中心放置一条水平线来删除单词。结果看起来像这样。此功能使可以指示某些单词是一个错误，要从文档中删除。若要删除单词，请在单词前后使用两个波浪号~~。

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

呈现的输出如下所示：

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

任务列表语法

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

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

呈现的输出如下所示：

Write the press release
Update the website
Contact the media

使用 Emoji 表情

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

复制和粘贴表情符号

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

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

使用表情符号简码

一些Markdown应用程序允许通过键入表情符号短代码来插入表情符号。这些以冒号开头和结尾，并包含表情符号的名称。

去露营了！ :tent: 很快回来。

真好笑！ :joy:

呈现的输出如下所示：

去露营了！ ⛺ 很快回来。

真好笑！ 😂

Note: 注意：可以使用此表情符号简码列表，但请记住，表情符号简码因应用程序而异。

自动网址链接

许多Markdown处理器会自动将URL转换为链接。这意味着如果输入http://www.example.com，即使未使用方括号，的Markdown处理器也会自动将其转换为链接。

禁用自动URL链接

如果不希望自动链接URL，则可以通过将URL表示为带反引号的代码来删除该链接。

`http://www.example.com`

呈现的输出如下所示：

http://www.example.com

展开折叠

在MarkDown中使用展开折叠功能依托于 HTML 5 中的 details 标签

定义和用法

<details> 标签用于描述文档或文档某个部分的细节。

标签可以为 details 定义标题。标题是可见的，用户点击标题时，会显示出 details。
summary 子标签，在此写入折叠的内容。

演示

<details><summary>展开/折叠</summary>
被折叠的内容
</details>

展开/折叠

被折叠的内容

This is the first footnote. ↩︎
Here's one with multiple paragraphs and code. ↩︎

posted @ 2022-06-18 19:40 iiYing 阅读(329) 评论(0) 编辑收藏举报

刷新页面返回顶部

MarkDown 语法学习笔记

MarkDown 学习笔记

MarkDown 简介

基本语法

标题语法

Heading level 1/

Heading level 1

Heading level 2/

Heading level 2

Heading level 3/

Heading level 3

Heading level 4/

Heading level 4

Heading level 5/

Heading level 5

段落语法

强调语法

粗体

斜体

粗斜体

引用语法

列表语法

有序列表

无序列表

代码语法

分隔线语法

链接语法

给链接加title

网址和 Email 地址

带格式的链接

引用类型链接

图片语法

链接图片

转义字符语法

特殊字符自动转义

内嵌 HTML 标签

行级內联标签

区块标签

拓展语法

表格

对齐

格式化表格中的文字

在表中转义管道字符

围栏代码块

语法高亮

脚注

标题编号

链接到标题ID

定义列表

任务列表语法

使用 Emoji 表情

复制和粘贴表情符号

使用表情符号简码

自动网址链接

禁用自动URL链接

展开折叠

定义和用法

演示

公告