Markdown 扩展语法

个人学习笔记,参考资料来自:中文版英文版

1. 表格

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

1
2
3
4
| Syntax    | Description |
| --------- | ----------- |
| Header | Title |
| Paragraph | Text |

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

1
2
3
4
| Syntax    | Description |
| --------- | ----------- |
| Header | Title |
| Paragraph | Text |

1.1 对齐

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

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

1.2 格式化表格中的文字

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

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

1.3 在表中转义管道字符

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

2. 围栏代码块

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

1
2
3
4
5
6
7
```
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
```

2.1 语法高亮

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

1
2
3
4
5
6
7
```json
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
```

3. 脚注

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

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

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

1
2
3
4
5
6
7
8
9
10
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.

4. 标题编号

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

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

HTML 看起来像这样:

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

4.1 链接到标题 ID

您可以通过创建一个带有数字符号(#)和自定义标题 ID 的标准链接来链接到文件中带有自定义 ID 的标题。

Markdown HTML
[Heading IDs](#heading-ids) <a href="#heading-ids">Heading IDs</a>

其他网站可以通过将自定义标题 ID 添加到网页的完整 URL 来链接到标题 (例如:[Heading IDs](https://www.markdownguide.org/extended-syntax#heading-ids))。

5. 定义列表

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

1
2
3
4
5
6
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看起来像这样:

1
2
3
4
5
6
7
<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>

6. 删除线

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

1
~~The world is flat.~~ We now know that the world is round.

7. 任务列表

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

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

8. 使用 Emoji 表情

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

8.1 复制和粘贴表情符号

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

💡 提示: 如果您使用的是静态网站生成器,请确保将HTML页面编码为UTF-8

8.2 使用表情符号简码

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

1
2
3
Gone camping! :tent: Be back soon.

That is so funny! :joy:

📝 注意: 您可以使用此list of emoji shortcodes,但请记住,表情符号简码因应用程序而异。有关更多信息,请参阅Markdown应用程序的文档。

9. 高亮

这并不常见,但某些Markdown处理器允许您突出显示文本。例如:==像这样==。要突出显示单词,请在单词前后使用两个等号(==)。

1
I need to highlight these ==very important words==.

或者,如果您的Markdown应用程序支持HTML,则可以使用HTML标记(mark)。

1
I need to highlight these <mark>very important words</mark>.

10. 下标

这并不常见,但某些Markdown处理器允许您使用下标将一个或多个字符放置在略低于正常文字行的位置。要创建下标,请在字符前后使用一个波浪号(~)。

1
H~2~O

💡 提示: 在使用之前,请务必在Markdown应用程序中对此进行测试。一些Markdown应用程序在单词前后使用一个波浪号,不是用于下标,而是用于删除线。

或者,如果您的Markdown应用程序支持HTML,则可以使用HTML标记(sub)。

1
H<sub>2</sub>O

11. 上标

这并不常见,但某些Markdown处理器允许您使用上标将一个或多个字符放置在略高于正常类型行的位置。要创建上标,请在字符前后使用一个插入符号(^)。

1
X^2^

或者,如果您的Markdown应用程序支持HTML,则可以使用HTML标记(sup)。

1
X<sup>2</sup>

12. 自动网址链接

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

1
http://www.example.com

12.1 禁用自动 URL 链接

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

1
`http://www.example.com`