MarkDown - 扩展语法

Markdown 扩展语法可用性

不是所有的 Markdown 引擎都支持扩展语法，所以在使用扩展语法之前，你可能需要对具体的 Markdown 引擎支持情况进行确认，通过浏览它们的使用文档来了解具体哪些元素可以得到支持。

主流的 Markdown 语法规范

Markdown 语法规范目前尚未形成标准，如下列出的几种语法规范较为主流。

其中 CommonMark 和 GFM 是目前最有可能进行标准化的。GFM 是 GitHub 基于 CommonMark 进行的扩展，它几乎已经是事实标准了，关于 CommonMark 规范要点解读可参考这里。

Markdown 处理器

有许多Markdown处理器可用。它们中的许多允许您添加启用扩展语法元素的扩展。查看您所使用处理器的文档以获取更多信息。

表格

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

| Syntax      | Description |
| ----------- | ----------- |
| Header      | Title       |
| Paragraph   | Text        |

呈现的输出如下所示：

Syntax	Description
Header	Title
Paragraph	Text

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

| Syntax | Description |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |

Tip: 使用连字符和管道创建表可能很麻烦。为了加快该过程，请尝试使用Markdown Tables Generator。使用图形界面构建表，然后将生成的Markdown格式的文本复制到文件中。

对齐

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

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

呈现的输出如下所示：

Syntax	Description	Test Text
Header	Title	Here’s this
Paragraph	Text	And more

格式化表格中的文字

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

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

在表中转义管道字符

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

Markdown 围栏代码块

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

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

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

以上两种代码块呈现的输出一样，如下所示：

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

语法高亮

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

```python
print('hello world!!!')
```

渲染效果如下：

print('hello world!!!')

脚注

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

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

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

这是一个简单地脚注[^1]，这是一个包含多个段落和代码的代码[^bignote]。

[^1]: 这是第一个简单脚注。

[^bignote]: 这是一个包含多个段落和代码的代码。

    缩进段落以将其包括在脚注中。

    `{我的代码}`

    添加任意多的段落。

呈现的输出如下所示：

这是一个简单地脚注^[1]，这是一个包含多个段落和代码的代码^[2]。

标题编号

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

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

HTML看起来像这样：

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

链接到标题ID (#headid)

通过创建带有数字符号（#）和自定义标题ID的[标准链接]((/basic-syntax/links.html)，可以链接到文件中具有自定义ID的标题。

Markdown	HTML	预览效果
[我的标题](#heading-id)	<a href="#heading-ids">我的标题</a>	我的标题

其他网站可以通过将自定义标题ID添加到网页的完整URL（例如[我的标题](https://a.com)）来链接到标题。

定义列表（缩进列表）

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

注：Typora不支持缩进列表

第一项术语 
: 这是第一项术语的定义。 

第二项术语 
: 这是第二项术语的定义。 
: 这是第二项术语的另一个定义。

HTML看起来像这样：

<dl>
  <dt>第一项术语</dt>
  <dd>这是第一项术语的定义。</dd>
  <dt>第二项术语</dt>
  <dd>这是第二项术语的定义。 </dd>
  <dd>这是第二项术语的另一个定义。</dd>
</dl>

呈现的输出如下所示：

第一项术语: 这是第一项术语的定义。
第二项术语: 这是第二项术语的定义。; 这是第二项术语的另一个定义。

删除线

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

~~世界是平坦的。~~ 我们现在知道世界是圆的。

呈现的输出如下所示：

~~世界是平坦的。~~ 我们现在知道世界是圆的。

任务列表语法

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

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

呈现的输出如下所示：

Write the press release
Update the website
Contact the media

使用 Emoij 表情

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

复制和粘贴表情符号

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

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

使用表情符号简码

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

去露营了！ :tent: 很快回来。

真好笑！ :joy:

呈现的输出如下所示：

去露营了！ ⛺ 很快回来。

真好笑！ 😂

注：您可以使用此表情符号简码列表，但请记住，表情符号简码因应用程序而异。有关更多信息，请参阅Markdown应用程序的文档。

表情符号简码列表

People Nature

😄 :smile: ☀️ :sunny:

☺️ :relaxed: ☁️ :cloud:

😉 :wink: ☔ :umbrella

更多表情请参考：

自动网址链接

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

http://www.example.com

呈现的输出如下所示：

http://www.example.com

禁用自动URL链接

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

`http://www.example.com`

呈现的输出如下所示：

http://www.example.com

这是第一个简单脚注。 ↩︎
这是一个包含多个段落和代码的代码。

缩进段落以将其包括在脚注中。

{我的代码}

添加任意多的段落。 ↩︎

posted @ 2022-01-07 14:51 夜、玥阅读(280) 评论(0) 收藏举报

刷新页面返回顶部

MarkDown - 扩展语法

MarkDown - 扩展语法