Markdown基本语法

Markdown 是一种轻量级标记语言，排版语法简洁，让人们更多地关注内容本身而非排版。它使用易读易写的纯文本格式编写文档，可与 HTML 混编，可导出 HTML、PDF 以及本身的 .md 格式的文件。因简洁、高效、易读、易写，Markdown 被大量使用，如Github、Wikipedia、简书等。

标题

要创建标题，在单词或短语前面添加井号 (#) 。# 的数量代表了标题的级别。考虑兼容性，应在 # 号与文本之间添加空格。

段落

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

换行

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

强调

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

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

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

引用

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

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

  • 块引用可以嵌套。

在要嵌套的段落前

添加一个 >> 符号。

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

列表

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

  • 无序列表

  • 要创建无序列表

  • 请在每个列表项前面添加破折号 (-)、星号 (*) 或加号 (+) 。

  • 缩进一个或多个列表项

    • 可创建嵌套列表。

  • 要在保留列表连续性的同时在列表中添加另一种元素，

    请将该元素缩进四个空格或一个制表符

  • 如本例所示

  • 除段落外，在列表中可以嵌套其他元素，引用快（>）、代码块（缩进八个空格或两个制表符）、图片、列表。

代码

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

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

  • 如果发现不方便，请尝试使用受保护的代码块。在代码块之前和之后的行上使用三个反引号（```）或三个波浪号（~~~）。

    code block

分隔线

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

链接

  • 超链接Markdown语法代码：超链接显示名，链接title可选。

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

  • 强调链接, 在链接语法前后增加星号。 要将链接表示为代码，请在方括号中添加反引号。

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

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

  1. 放在括号中的标签，其后紧跟一个冒号和至少一个空格（例如[label]:）。
  2. 链接的URL，可以选择将其括在尖括号中。
  3. 链接的可选标题，可以将其括在双引号，单引号或括号中。
  4. 示例：[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> (Hobbit lifestyles)

图片

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

这是图片

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

转义字符

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

内嵌 HTML 标签

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

详情请查看Markdown语法官方教程

Markdow 扩展语法

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

表格

  • 要添加表，请使用三个或多个连字符（—）创建每列的标题，并使用管道（|）分隔每列。选择在表的任一端添加管道
    | Syntax      | Description |
    | ----------- | ----------- |
    | Header      | Title       |
    | Paragraph   | Text        |
  • 通过在标题行中的连字符的左侧，右侧或两侧添加冒号（:），将列中的文本对齐到左侧，右侧或中心。
    | Syntax      | Description | Test Text     |
    | :---        |    :----:   |          ---: |
    | Header      | Title       | Here's this   |
    | Paragraph   | Text        | And more      |
  • 可以在表格中设置文本格式。例如，您可以添加链接，代码（仅反引号（`）中的单词或短语，而不是代码块）和强调。不能添加标题，块引用，列表，水平规则，图像或HTML标签。

围栏代码块

将在代码块之前和之后的行上使用三个反引号（```）或三个波浪号（~~~）。

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

标题编号

  • 自定义标题ID：添加自定义ID允许直接链接到标题并使用CSS对其进行修改。要添加自定义标题ID，请在与标题相同的行上用大括号括起该自定义ID。
    ### My Great Heading {#custom-id}
  • 链接到标题ID : 通过创建带有数字符号（#）和自定义标题ID的标准链接，可以链接到文件中具有自定义ID的标题。
    | Markdown |	HTML |	预览效果 |
    | ------- | ------ | --------- |
    | [Heading IDs](#heading-ids) |	<a href="#heading-ids">Heading IDs</a> |	Heading IDs |

定义列表

创建定义列表，请在第一行上键入术语。在下一行，键入一个冒号，后跟一个空格和定义。

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

Emoji 表情

将表情符号复制并粘贴到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表示为带反引号的代码来删除该链接