跳转至

Markdown 基本语法

笔记来源：Markdown 教程

快速总结：

  1. 创建标题

    • 创建标题，请在单词或短语前面添加井号 (#) 。# 的数量代表了标题的级别。
    • 可以在文本下方添加任意数量的 == 号来标识一级标题，或者 -- 号来标识二级标题。
    • 为了兼容考虑，请用一个空格在 # 和标题之间进行分隔。

  2. 创建段落

    • 要创建段落，请使用空白行将一行或多行文本进行分隔。
    • 不要用空格（spaces）或制表符（ tabs）缩进段落。

  3. 换行

    • 在一行的末尾添加两个或多个空格，然后按回车键,即可创建一个换行(<br>)。
    • 为了兼容性，请在行尾添加“结尾空格”或 HTML 的 <br> 标签来实现换行

  4. 粗文本与斜体显示文本(强调)

    • 要加粗文本，请在单词或短语的前后各添加两个星号（asterisks）或下划线（underscores）。为兼容考虑，在单词或短语中间部分加粗的话，请使用星号（asterisks）。
    • 要用斜体显示文本，请在单词或短语前后添加一个星号（asterisk）或下划线（underscore）。
    • 同时用粗体和斜体突出显示文本，请在单词或短语的前后各添加三个星号或下划线。为了实现兼容性，请使用星号将单词或短语的中间部分加粗并以斜体显示，以示重要。

  5. 引用

    • 要创建块引用，请在段落前添加一个 > 符号。
    • 块引用可以包含多个段落。为段落之间的空白行添加一个 > 符号。
    • 块引用可以嵌套。在要嵌套的段落前添加一个 >> 符号。
    • 块引用可以包含其他 Markdown 格式的元素。并非所有元素都可以使用

  6. 列表

    • 要创建有序列表，请在每个列表项前添加数字并紧跟一个英文句点。数字不必按数学顺序排列，但是列表应当以数字 1 起始。
    • 要创建无序列表，请在每个列表项前面添加破折号 (-)、星号 (*) 或加号 (+) 。缩进一个或多个列表项可创建嵌套列表。为了兼容性，不要在同一列表中混合匹配分隔符------选择一个并坚持使用它。
    • 要在保留列表连续性的同时在列表中添加另一种元素，请将该元素缩进四个空格或一个制表符
    • 代码块通常采用四个空格或一个制表符缩进。当它们被放在列表中时，请将它们缩进八个空格或两个制表符。
    • 可以在有序列表中嵌套无序列表，反之亦然。

  7. 代码

    • 要将单词或短语表示为代码，请将其包裹在反引号 ( ` ) 中。
    • 如果你要表示为代码的单词或短语中包含一个或多个反引号，则可以通过将单词或短语包裹在双反引号( `` )中。
    • 要创建代码块，请将代码块的每一行缩进至少四个空格或一个制表符。
    • 要创建不用缩进的代码块，请使用 围栏式代码块（fenced code blocks）.

  8. 分隔线

    • 要创建分隔线，请在单独一行上使用三个或多个星号 (***)、破折号 (---) 或下划线 (___) ，并且不能包含其他内容。以上三个分隔线的渲染效果看起来都一样
    • 为了兼容性，请在分隔线的前后均添加空白行。

  9. 链接

    • 超链接Markdown语法代码：[超链接显示名](超链接地址 "超链接title")
    • 链接title是当鼠标悬停在链接上时会出现的文字，这个title是可选的，它放在圆括号中链接地址后面，跟链接地址之间以空格分隔。
    • 使用尖括号可以很方便地把URL或者email地址变成可点击的链接。
    • 强调链接, 在链接语法前后增加星号。 要将链接表示为代码，请在方括号中添加反引号。
    • 引用样式链接是一种特殊的链接，它使URL在Markdown中更易于显示和阅读。参考样式链接分为两部分：与文本保持内联的部分以及存储在文件中其他位置的部分，以使文本易于阅读。
      • 引用类型的链接的第一部分使用两组括号进行格式设置。第一组方括号包围应显示为链接的文本。第二组括号显示了一个标签，该标签用于指向您存储在文档其他位置的链接。 引用类型的链接的第一部分使用两组括号进行格式设置。第一组方括号包围应显示为链接的文本。第二组括号显示了一个标签，该标签用于指向您存储在文档其他位置的链接。
      • 引用类型链接的第二部分使用以下属性设置格式： 放在括号中的标签，其后紧跟一个冒号和至少一个空格（例如[label]:）。 链接的URL，可以选择将其括在尖括号中。 链接的可选标题，可以将其括在双引号，单引号或括号中。 可以将链接的第二部分放在Markdown文档中的任何位置。有些人将它们放在出现的段落之后，有些人则将它们放在文档的末尾（例如尾注或脚注）。
      • 不同的 Markdown 应用程序处理URL中间的空格方式不一样。为了兼容性，请尽量使用%20代替空格。

  10. 图片

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

  11. 转义字符

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

  12. 内嵌 HTML 标签

    • HTML 的行级內联标签如 <span>、<cite>、<del> 不受限制，可以在 Markdown 的段落、列表或是标题里任意使用。依照个人习惯，甚至可以不用 Markdown 格式，而采用 HTML 标签来格式化。
    • 区块元素──比如 <div>、<table>、<pre>、<p> 等标签，必须在前后加上空行，以便于内容区分。而且这些元素的开始与结尾标签，不可以用 tab 或是空白来缩进。Markdown 会自动识别这区块元素，避免在区块标签前后加上没有必要的 <p> 标签。
    • 出于安全原因，并非所有 Markdown 应用程序都支持在 Markdown 文档中添加 HTML。对于 HTML 的块级元素 <div>、<table>、<pre 和 <p>，请在其前后使用空行（blank lines）与其它内容进行分隔。尽量不要使用制表符（tabs）或空格（spaces）对 HTML 标签做缩进，否则将影响格式。