语法标记#
本页作为MyST Markdown语法参考。
参见
有关MyST语法的更多描述和解释,请参阅语法指南。
1. 块(多行)标记#
块标记跨越多行内容。它们被分为两个部分:
扩展块标记 包含了 额外 的标记,这些标记并不属于 CommonMark 标准。
CommonMark 标记 包含了同样适用的 CommonMark 标记,以供参考。
备注
由于 MyST Markdown 的灵感来源于 reStructuredText 中存在的功能,在下面展示了许多 MyST Markdown 特性对应的 rST 语法。
1.1. 扩展块标记#
Token |
描述 |
示例 |
---|---|---|
FrontMatter |
文档开头由 |
---
key: value
---
|
指令 |
用 3 个或更多反引号包围,并在其后跟随用花括号 |
```{directive}
:option: value
content
```
|
数学 |
使用 |
$$
a=1
$$
|
表格 |
标准 Markdown 表格样式,使用竖线分隔。 |
| a | b |
| :--- | ---: |
| c | d |
|
行注释 |
注释行。更多信息请参阅 注释。 |
% this is a comment
|
块分隔符 |
定义文本块。更多信息请参阅 主题分隔线 。 |
+++ {"meta": "data"}
|
脚注 |
用于引用脚注的定义,放置在文档底部。更多详情请参阅 脚注。 |
[^ref]: Some footnote text
|
提示框(可选) |
仅用于admonition样式指令的替代方法,其优点是允许内容在标准Markdown编辑器中渲染。更多详情请参阅 admonition指令。 |
:::{note}
*content*
:::
|
1.2. CommonMark 标记#
Token |
描述 |
示例 |
---|---|---|
HTML 块 |
任何有效的 HTML(仅在 HTML 输出中渲染) |
<p>some text</p>
|
代码块 |
缩进文本(4 个空格或一个制表符) |
included as literal *text*
|
标题 |
1-6级标题,由 |
### Heading level 3
|
Setext 标题 |
带下划线的标题(使用多个 |
Header
======
|
引用 |
引用文本 |
> this is a quote
|
代码围栏 |
用 3 个或更多 |
```python
print('this is python')
```
|
主题分隔线 |
在输出中创建水平线 |
---
|
列表 |
项目符号或编号列表。 |
- item
- nested item
1. numbered item
|
链接定义 |
用于替换内联链接,可以包含引用目标(无空格)和可选的标题(在 |
[key]: https://www.google.com "a title"
|
段落 |
通用内联文本 |
any *text*
|
2. 区间(内联)标记#
区间(或内联)标记在内容的单行上定义。它们在下面被分为两个部分:
扩展内联标记 包含了 额外 的标记,这些标记不在 CommonMark 标准中。
CommonMark 内联标记 包含了同样适用的 CommonMark 标记,以供参考。
2.1. 扩展内联标记#
Token |
描述 |
示例 |
---|---|---|
角色 |
更多信息请参见 Roles - an in-line extension point。 |
{rolename}`interpreted text`
|
目标 |
位于目标元素(例如标题)之前。更多信息请参见 创建显式目标。 |
(target)=
|
数学 |
默认使用 |
$a=1$ or $$a=1$$
|
脚注引用 |
引用脚注。更多详情请参见 脚注。 |
[^abc]
|
2.2. CommonMark 内联标记#
Token |
描述 |
示例 |
---|---|---|
HTML 内联 |
任何有效的 HTML(仅在 HTML 输出中渲染) |
<p>some text</p>
|
转义序列 |
转义的符号(以避免它们被解释为其他语法元素) |
\*
|
自动链接 |
在最终输出中显示的链接 |
<http://www.google.com>
|
内联代码 |
字面文本 |
`a=1`
|
换行符 |
软换行或硬换行(以空格或反斜杠结尾) |
A hard break\
|
图片 |
链接到图片。你也可以使用 HTML 语法来包含图片尺寸等信息,详情请参见此处。 |
![alt](src "title")
|
链接 |
参考 |
[text](target "title") or [text][key]
|
加粗 |
加粗文本 |
**strong**
|
强调 |
斜体文本 |
*emphasis*
|
纯文本 |
任何文本 |
any text
|