Markdown 的使用

Markdown 系列有三部分构成：

编辑器

所编即所得，是当前非常热门的Markdown编辑器
Visual Studio Code，需要一些配置，但也十分的简单易用。

Markdown 基本语法

总述：Markdown 是一种轻量级的标记语言，排班语法简介，让人更容易关注内容本身而非排版，它使用易读易写的纯文本格式编写文档，可与HTML混编，可导出 HTML、PDF 以及本身的 .md 格式的文件。因简洁、高效、易读、易写，Markdown被大量使用，如Github、Wikipedia等网站，如各大博客平台：CSDN、博客园、简书等。

「标记」、「语言」等听起来很高大上，实则在Markdown中非常简单，你只需要记住不超过十个标记就能处理日常中的大多数事务。这将大大提升你的工作效率。

本文仅供学习参考用途，参考网站有：

Markdown 基本语法 | Markdown 语法教程

标题

要创建标题，请在单词或短语前面添加井号 (#) 。# 的数量代表了标题的级别。例如，添加三个 # 表示创建一个三级标题 (<h3>) (例如：### My Header)。

Markdown语法	HTML
`# Heading level 1`	`<h1>Heading level 1</h1>`
`## Heading level 2`	`<h2>Heading level 2</h2>`
`### Heading level 3`	`<h3>Heading level 3</h3>`
`#### Heading level 4`	`<h4>Heading level 4</h4>`
`##### Heading level 5`	`<h5>Heading level 5</h5>`
`###### Heading level 6`	`<h6>Heading level 6</h6>`

不同的 Markdown 应用程序处理 # 和标题之间的空格方式并不一致。为了兼容考虑，请用一个空格在 # 和标题之间进行分隔。

✅ Do this	❌ Don’t do this
`# Here's a Heading`	`#Here's a Heading`

段落

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

Markdown语法	HTML	预览效果
`I really like using Markdown.` `I think I'll use it to format all of my documents from now on.`	`<p>I really like using Markdown.</p>` `<p>I think I'll use it to format all of my documents from now on.</p>`	I really like using Markdown. I think I’ll use it to format all of my documents from now on.

不要用空格（spaces）或制表符（ tabs）缩进段落。在Markdown渲染时并不会显示缩进。

换行

在一行的末尾添加两个或多个空格，然后按回车键，即可创建一个换行(<br>)。

Markdown语法	HTML	预览效果
`This is the first line.` `And this is the second line.`	`<p>This is the first line.` `<br>` `And this is the second line.</p>`	This is the first line. And this is the second line.

几乎每个 Markdown 应用程序都支持两个或多个空格进行换行，称为 结尾空格（trailing whitespace) 的方式，但这是有争议的，因为很难在编辑器中直接看到空格，并且很多人在每个句子后面都会有意或无意地添加两个空格。由于这个原因，你可能要使用除结尾空格以外的其它方式来换行。幸运的是，几乎每个 Markdown 应用程序都支持另一种换行方式：HTML 的 <br> 标签。

为了兼容性，请在行尾添加“结尾空格”或 HTML 的 <br> 标签来实现换行。

强调

粗体

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

1
2
3

**strongcontent**
__strongcontent__
stro**ngc**ontent

strongcontent

strongcontent

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

斜体

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

1
2
3

*Italiccontent*
_Italiccontent_
Itali*cco*ntent

Italiccontent

Italiccontent

与加粗一样，要用斜体突出单词的中间部分，请使用星号（asterisks）*。

粗体与斜体

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

This ***text*** is really important.
This ___text___ is really important.
This __*text*__ is really important.
This **_text_** is really important.
This t***ex***t is really important.

This text is really important.

This text is really important.

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

引用

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

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
2
3

> 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.

嵌套块引用

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

1
2
3

> 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**.

渲染效果如下：

The quarterly results look great!

Revenue was off the chart.

Profits were higher than ever.

Everything is going according to plan.

列表

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

有序列表

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

First item
Second item
Third item
Fourth item

请确保有序列表序号中的点是英文格式的点，另外请不要使用 1、, 1) 等格式。

无序列表

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

- 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
Fourth item

First item
Second item
Third item
- Indented item
- Indented item
Fourth item

在列表中嵌套其他元素

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

段落

*   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.

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.

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
    <html>
    <head>
        <title>Test</title>
    </head>

Update the title to match the name of your website.


1.  Open the file.
2.  Find the following code block on line 21:
	```html
    <html>
    <head>
    	<title>Test</title>
    </head>

Update the title to match the name of your website.

图片

1.  Open the file containing the Linux mascot.
2.  Marvel at its beauty.

    ![img](https://typora.io/img/favicon-64.png)

3.  Close the file.

Open the file containing the Linux mascot.
Marvel at its beauty.
Close the file.

列表

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

First item
Second item
Third item
- Indented item
- Indented item
Fourth item

代码

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

1	At the command prompt, type `nano`.

At the command prompt, type nano.

转义反引号

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

1	``Use `code` in your Markdown file.``

Use `code` in your Markdown file.

代码块

Markdown基本语法允许您通过将行缩进四个空格或一个制表符来创建代码块。但这种写法不方便，可以直接用两个 ``` 进行包裹

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

呈现出的效果如下：

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

若想要语法高亮，可以在反引号后指定语言

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

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

分割线

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

***

---

---------------

呈现样式如下：

为了兼容性，请在分隔线的前后均添加空白行。

Try to put a blank line before...

---

...and after a horizontal rule.

链接

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

超链接Markdown语法代码：[超链接显示名](超链接地址 "超链接title")

对应的HTML代码：<a href="超链接地址" title="超链接title">超链接显示名</a>

1	这是一个链接 [Markdown语法](https://markdown.com.cn)。

渲染效果如下：

这是一个链接 Markdown语法。

链接的更多应用请戳：Markdown 链接语法

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

[link](https://www.example.com/my%20great%20page)

图片

插入图片Markdown语法代码：![图片alt](图片链接 "图片title")。

对应的HTML代码：<img src="图片链接" alt="图片alt" title="图片title">

1	![这是图片](https://typora.io/img/favicon-64.png)

这是图片

链接图片

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

1	[![这是图片](https://typora.io/img/favicon-64.png)](https://typora.io)

渲染效果如下：

转义字符语法

要显示原本用于格式化 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