Markdown 模版

# 一、Markdown 标题语法

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

# 可选语法：

还可以在文本下方添加任意数量的 == 号来标识一级标题，或者 – 号来标识二级标题。

# 二、Markdown 段落语法

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

不要用空格（spaces）或制表符（ tabs）缩进段落

# 三、Markdown 换行语法

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

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

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

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

# 四、Markdown 强调语法

通过将文本设置为粗体或斜体来强调其重要性。

# 粗体（Bold）：

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

# 斜体（Italic）：

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

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

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

# 删除线:

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

示例入下：

删除线

# 五、Markdown 引用语法

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

>这是一个引用语句

效果如下：

这是一个引用语句；

# 多个段落的块引用：

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

段落一；

段落二；

# 嵌套块引用：

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

> 段落一;

>

>> 嵌套段落二;

效果如下：

段落一；

段落二；

# 带有其它元素的块引用：

块引用可以包含其他 Markdown 格式的元素。并非所有元素都可以使用，你需要进行实验以查看哪些元素有效。

可以使用的元素如下（后续如有还会补充）

斜体

粗体

粗斜体

• 无序列表 1
• 无序列表 2

# 六、Markdown 列表语法

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

# 有序列表：

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

如下所示

1. 有序列表 1
2. 有序列表 2
3. 有序列表 3

# 无序列表：

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

• 无序列表 1

  • 无序列表 1.1
  • 无序列表 1.2

• 无序列表 2

# 在列表中嵌套其他元素：

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

1. 有序列表 1
   • 无序列表 1
   • 无序列表 2
2. 有序列表 2

# 七、Markdown 代码语法

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

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

这是一段代码！！！！

# Markdown 围栏代码块:

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

这个是一个代码块

    hello world！！！

return

# 语法高亮：

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

```json

{

  "firstName": "John",

  "lastName": "Smith",

  "age": 25

}

```

# 八、 Markdown 分隔线语法

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

***

---

_________________

如下图所示：

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

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

# 九、Markdown 链接语法

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

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

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

示例：

这是一个 Markdown 语法链接 Markdown 官方教程。

这是一个 HTML 语法链接Markdown 官方教程。

# 给链接增加 Title:

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

这是一个 Markdown 语法链接 Markdown 官方教程。

这是一个 HTML 语法链接Markdown 官方教程。

# 网址和 Email 地址:

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

<https://markdown.com.cn>

https://markdown.com.cn

# 引用类型链接:[一般用不到]

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

# 链接的第一部分格式

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

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

以下示例格式对于链接的第一部分效果相同：

• [hobbit-hole][1]
• [hobbit-hole] [1]

# 链接的第二部分格式

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

1. 放在括号中的标签，其后紧跟一个冒号和至少一个空格（例如 [label]: ）。
2. 链接的 URL，可以选择将其括在尖括号中。
3. 链接的可选标题，可以将其括在双引号，单引号或括号中。

# 十、Markdown 图片语法

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

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

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

# 链接图片：

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

# 十一、Markdown 转义字符语法

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

\* Without the backslash, this would be a bullet in an unordered list.

渲染效果如下：

* Without the backslash, this would be a bullet in an unordered list.

# 特殊字符自动转义:

在 HTML 文件中，有两个字符需要特殊处理： < 和 & 。 < 符号用于起始标签， & 符号则用于标记 HTML 实体，如果你只是想要使用这些符号，你必须要使用实体的形式，像是 < 和 & 。Markdown 允许你直接使用这些符号，它帮你自动转义字符。如果你使用 & 符号的作为 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>Foo</td>
    </tr>
</table>

This is another regular paragraph.

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

# HTML 用法最佳实践：

出于安全原因，并非所有 Markdown 应用程序都支持在 Markdown 文档中添加 HTML。如有疑问，请查看相应 Markdown 应用程序的手册。某些应用程序只支持 HTML 标签的子集。

对于 HTML 的块级元素 <div> 、 <table> 、 <pre> 和 <p> ，请在其前后使用空行（blank lines）与其它内容进行分隔。尽量不要使用制表符（tabs）或空格（spaces）对 HTML 标签做缩进，否则将影响格式。

在 HTML 块级标签内不能使用 Markdown 语法。例如 <p>italic and **bold**</p> 将不起作用。

# 十三、Markdown 表格（使用 Markdown 软件 直接添加表格内容）

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

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

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

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

# 十四、Markdown 脚注

脚注，又名注脚，是读书所做的笔录、见解、体会、看法、观点、心得、感想的总称。脚注分为：头注、侧注、后注、割注、分注。来自维基百科

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

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

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

# 十五、任务列表语法

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

• 大方
• 帅气
• 多金

# 十六、使用 Emoji 表情

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

# 复制和粘贴表情符号

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

🤣

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

# 使用表情符号简码

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