如何贡献¶

欢迎贡献基岩文档。我们非常感谢您的帮助，无论是提交错误报告、修复错误、改进文档或提供新的内容。在作出贡献之前，请阅读以下指南。

构建与编辑文档¶

本网站文档使用Material for MkDocs软件提供支持。要在本地构建和编辑文档，您需要安装以下软件：

在一切开始之前，请务必保证自身设备中安装有cairo库和libcairo-2库。要做到这一点，只需要安装GTK；如果您在使用Windows系统，请至tschoonj/GTK-for-Windows-Runtime-Environment-Installer安装最新的GTK Windows安装程序。

在安装完成Python后，您可以在控制台中运行如下命令以安装依赖：

pip install mkdocs-material[recommended,git,imaging]
pip install mkdocs-rss-plugin
pip install mkdocs-git-revision-date-localized-plugin
pip install mkdocs-git-committers-plugin-2
pip install mkdocs-minify-plugin
pip install mkdocs-glightbox

这将安装MkDocs和Material for MkDocs以及其他必要的插件。然后，您可以在本项目的根目录于控制台中使用python -m mkdocs serve --dirtyreload命令，此命令会开启实时托管，此后即可在localhost:8000实时看到做出的更改。

注意，如果发生错误，请将tools文件夹复制(1)到docs文件夹内再重新执行托管命令。

注意：不是移动。

在第一次运行时，MkDocs会自动联网获取各文件的贡献者，可能会稍加缓慢，请耐心等待；之后再次运行时，只会重新获取已改动文件的贡献者，不会再耗费太多时间。

在完成编辑后，您可以提交并推送更改。GitHub Actions会自动构建并将文档推送至GitHub Pages。然后，您可以在https://miemiemethod.github.io/bedrock-docs/查看更改后的效果。

文档语法¶

本文档使用Markdown语法编写。如果您不熟悉Markdown语法，可以参考这篇文章，或这篇中文文章。此外，您还可以参考Material for MkDocs的文档以了解更多关于Material for MkDocs的独有语法，以及参考PyMdown Extensions的文档以了解更多关于PyMdown Extensions提供的额外语法。本站加载有所有PyMdown Extensions提供的扩展，请编者放心使用。

此外，此处也以中文语言重新记录了一些上述提供的额外语法：

一般内联语法¶

描述	语法	效果
删除线	`~~删除~~`	删除
下划线	`^^插入^^`	插入
下标	`~下标~`	_下标
上标	`^上标^`	^上标
插入	`{++插入++}`	插入
移除	`{--移除--}`	移除
替换	`{~~A~>B~~}`	AB
文本高亮	`{==高亮==}` `==高亮==`	高亮
注释	`{>>注释<<}`	注释
代码高亮	`#!js foo = 1 / 2;`	`foo = 1 / 2;`
快捷键	`++ctrl+alt+delete++`	`Ctrl`＋`Alt`＋`Del`
进度条	`[=85% "85%"]`	85%
Wiki链接	`[[方块]]` `[[mcwzh:方块\|]]` `[[mcwzh:方块\|Minecraft Wiki:方块]]`	方块方块 Minecraft Wiki:方块

值得注意的是，如果上下标中含有空格，空格需要转义，即使用\ 代替单纯的。快捷键语法中的各键位标识符详见Keys扩展文档。进度条允许注入一些类使其变成糖衣色、动态糖衣色或窄进度条，具体详见ProgressBar扩展文档。

对于强调语法（斜体和加粗），我们区分了*、**与_、__的用法。*、**未开启智能语法；_、__开启了智能语法，具体的智能语法可以参考BetterEm扩展文档，但智能语法具有在中文中必须空格才能被正确解析的缺点。例如：

能够*被正确强调*。

不能_被正确强调_。

能够 _被正确强调_。

能够被正确强调。

不能_被正确强调_。

能够 被正确强调。

注入特性¶

依赖于Attribute Lists扩展，本文档支持向HTML标签注入特性。在一个可能会被解析为HTML标签的语法结构之后使用语法{:.class #id key=value key="spaced value"}来注入特性，其中.class代表类，#id代表锚点ID，key=value代表键值对，key="spaced value"代表键值对中的值含有空格，每一种皆是可选的，其中类和键值对可以有任意多个。此外，{: }中的冒号可以省略，即{.class #id key=value key="spaced value"}也是合法的。例如给一个段落的<p>标签注入：

这是一个段落。
{:.data-class #custom-id key1=value key2="spaced value"}

HTML效果

<p class="data-class" id="custom-id" key1="value" key2="spaced value">这是一个段落。</p>

这是一个段落。

围栏¶

围栏语法即代码块语法，可以使用三个或三个以上的~或`作为包装字面量。为了规范，我们要求在本站点贡献时，只可使用三个`的包装语法。本站围栏使用Pygments进行代码高亮，并通过SuperFences扩展进行了封装。您可以使用title、linenums、hl_lines三个参数来定制围栏。

linenums的第一个参数是起始行号，第二个参数是显示行号的步长，第三个参数是特殊行号的步长；如不指定该参数，则不显示行号。hl_lines代表高亮的行。可以用单个行号或用短横杠-表示从第几行至第几行，之间用空格隔开。

围栏也可以使用上述注入的方式指定参数，例如以下两种格式的输出是等价的：

常规注入

```python title="示例" linenums="1 2 3" hl_lines="1-2 5 7-8"
import foo
import boo.baz
import foo.bar.baz

class Foo:
   def __init__(self):
       self.foo = None
       self.bar = None
       self.baz = None
```

示例

import foo
import boo.baz
import foo.bar.baz

class Foo:
   def __init__(self):
       self.foo = None
       self.bar = None
       self.baz = None

```{.python title="示例" linenums="1 2 3" hl_lines="1-2 5 7-8"}
import foo
import boo.baz
import foo.bar.baz

class Foo:
   def __init__(self):
       self.foo = None
       self.bar = None
       self.baz = None
```

示例

import foo
import boo.baz
import foo.bar.baz

class Foo:
   def __init__(self):
       self.foo = None
       self.bar = None
       self.baz = None

关于更多的注入相关信息，可以参考SuperFences扩展文档。

内容块¶

内容块是一种特殊的块级元素，通过三个或三个以上的/包装。大致语法如下：

/// name | argument
    options1: value
    options2: value
    ...
这是一个内容块，此处是正常Markdown内容。
///

内容块嵌套时，可以使用///和////等来表示不同级别的嵌套。往往越深的嵌套级别越多个/。

警告块¶

警告块是一种特殊的内容块，用于强调一些需要注意的内容。最简单的语法如下：

/// admonition | 标题
内容。
///

标题

内容。

实际上，警告块有多种类型，可以通过type选项来指定。若没有指定，默认为note。此外，可以用类型标识符替换admonition实现快速给出该类型的警告块。例如。以下两种格式的输出是一致的：

常规快捷

/// admonition | 标题
    type: warning
内容。
///

标题

内容。

/// warning | 标题
内容。
///

标题

内容。

下面给出了本站所有可用的警告块类型：

newsettingsnoteabstractinfotipsuccessquestionwarningfailuredangerbugexamplequote

/// new | 标题
内容。
///

标题

内容。

/// settings | 标题
内容。
///

标题

内容。

/// note | 标题
内容。
///

标题

内容。

/// abstract | 标题
内容。
///

标题

内容。

/// info | 标题
内容。
///

标题

内容。

/// tip | 标题
内容。
///

标题

内容。

/// success | 标题
内容。
///

标题

内容。

/// question | 标题
内容。
///

标题

内容。

/// warning | 标题
内容。
///

标题

内容。

/// failure | 标题
内容。
///

标题

内容。

/// danger | 标题
内容。
///

标题

内容。

/// bug | 标题
内容。
///

标题

内容。

/// example | 标题
内容。
///

标题

内容。

/// quote | 标题
内容。
///

标题

内容。

此外，您可以使用attrs选项来更改类、ID和其他特性。更多的功能可以参考Admonition扩展文档。

将admonition替换为details可以将警告块转换为详情块。详情块是一种特殊的警告块，用于隐藏一些内容。例如：

常规快捷

/// details | 标题
    type: warning
内容。
///

标题

内容。

/// details-warning | 标题
内容。
///

标题

内容。

HTML块¶

HTML块是一种将Markdown内容包裹在任意HTML元素中的内容块。使用html作为内容块类型，并在|后指定标签名。类、ID和其他特性可以用类似CSS选择器的语法直接附加在标签名后。例如：

/// html | div
这是一个被`<div>`包裹的内容。
///

/// html | div.my-class#my-id
这是一个带有类和ID的`<div>`。
///

/// html | div[style="color: red;"]
这段文字是红色的。
///

这是一个被<div>包裹的内容。

这是一个带有类和ID的<div>。

这段文字是红色的。

默认情况下，HTML块会根据标签名自动判断内容的处理方式：div等块级元素的内容会按块级Markdown解析，span等行内元素的内容会按行内Markdown解析，pre等标签的内容则视为原始文本。如果需要手动指定，可以使用markdown选项。可用的模式有block、inline、raw、auto和html。例如，强制pre按块级Markdown解析：

/// html | pre
    markdown: block
这段内容会被按**Markdown**解析。
///

这段内容会被按Markdown解析。

更多的功能可以参考HTML扩展文档。

定义列表¶

定义列表通过define内容块来创建。将术语作为段落，定义作为列表项。例如：

/// define
苹果

- 蔷薇科苹果属的水果。

橘子

- 芸香科柑橘属的水果。

///

苹果: 蔷薇科苹果属的水果。
橘子: 芸香科柑橘属的水果。

多个术语也可以共享同一个定义：

/// define
术语1

术语2

- 共享的定义。

术语3

- 另一个定义。

///

术语1
术语2: 共享的定义。
术语3: 另一个定义。

更多的功能可以参考Definition扩展文档。

标签组¶

标签组通过连续的tab内容块来创建，每个tab需要在|后指定标签标题。连续的标签块会自动归为一组。例如：

/// tab | 标签1
标签1的内容。
///

/// tab | 标签2
标签2的内容。
///

标签1标签2

标签1的内容。

标签2的内容。

如果需要在两个紧邻的标签组之间强制断开，可以使用new选项：

/// tab | 标签A
内容A。
///

/// tab | 标签B
内容B。
///

/// tab | 标签C
    new: true
这是一个新标签组。
///

标签A标签B

内容A。

内容B。

标签C

这是一个新标签组。

更多的功能可以参考Tab扩展文档。

图注表注¶

图注和表注通过caption、figure-caption和table-caption内容块来创建。将caption块紧跟在需要添加注释的内容（如图片或表格）之后即可。figure-caption和table-caption会自动添加带有编号的前缀（如"Figure 1."和"Table 1."）并自动生成锚点ID。例如：

通用图注图注表注

![placeholder](https://dummyimage.com/600x200/eee/aaa)

/// caption
一般图注，无编号前缀。
///

![placeholder](https://dummyimage.com/600x200/eee/aaa)

/// figure-caption
带有自动编号的图注。
///

| 水果   | 数量 |
|--------|------|
| 苹果   | 20   |
| 香蕉   | 3    |

/// table-caption
水果数量统计表。
///

水果	数量
苹果	20
香蕉	3

Table 1. 水果数量统计表。

默认图注添加在内容下方。若需要将图注置于内容上方，可以在|后使用<标记：

![placeholder](https://dummyimage.com/600x200/eee/aaa)

/// figure-caption | <
前置图注。
///

更多的功能可以参考Caption扩展文档。

注解¶

注解通过注入annotate类，紧跟着给出一个有序列表来实现。例如，在段落中使用注解：

这是一个段落(1)。
{.annotate}

1.  这是一个注解。

这是一个段落(1)。

这是一个注解。

注解可以在任何支持注入的地方使用。例如，在围栏中使用注解：

常规隐藏注释

```{.python .annotate}
print("Hello, World!") # 这是一个注释。(1)
```

1.  这是一个注解。

print("Hello, World!") # 这是一个注释。(1)

这是一个注解。

```{.python .annotate}
print("Hello, World!") # 这是一个注释。(1)!
```

1.  这是一个注解。

print("Hello, World!") # 这是一个注释。(1)!

这是一个注解。

有些地方虽然不支持注入语法，但是支持自定义类，因此也可以使用注解。例如，在内容块中使用注解：

警告块HTML块标签组

/// note | 注
    attrs: { class: annotate }
这是一个内容块(1)。
///

1.  这是一个注解。

注

这是一个内容块(1)。

这是一个注解。

/// html | div.annotate
这是一个内容块(1)。
///

1.  这是一个注解。

这是一个内容块(1)。

这是一个注解。

/// tab | 标签1
这是一个内容块(1)。
///
/// tab | 标签2
    attrs: { class: annotate }
这是一个内容块(2)。
///

1.  这是一个注解。
2.  这是第二个注解。

标签1标签2

这是一个内容块(1)。

这是一个内容块(2)。

这是一个注解。
这是第二个注解。

您可以在注解中使用内联语法，以及使用另一个注解。例如：

这是一个段落(1)。
{.annotate}

1.  这是一个注解。在注解底部缩进对齐使用`{.annotate}`以在注解中添加注解。(1)
    {.annotate}

    1.  这里是第二个注解。

这是一个段落(1)。

这是一个注解。在注解底部缩进对齐使用{.annotate}以在注解中添加注解。(1)
1. 这里是第二个注解。

公式¶

本站使用MathJax渲染数学公式，支持LaTeX语法。公式分为行内公式和块级公式。

行内公式使用 $...$ 或$...$包裹，例如：

质能方程$E = mc^2$由爱因斯坦提出。

质能方程$E = mc^2$由爱因斯坦提出。

块级公式使用$$...$$或\[...\]包裹，且需要单独成行：

$$
\cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k}
$$

\[
\cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k}
\]

图片¶

图片可以通过注入实现左右对齐、设置宽度和懒加载等，具体详见Material for MkDocs图片参考文档。此外，在本站，如果使用图注，请使用图注块来添加图注，而不是按照前者参考文档指导的方法进行添加。

按钮¶

通过注入.md-button类，可以将任何链接渲染为按钮。添加.md-button--primary类可以将其渲染为实心按钮。按钮也支持添加图标。例如：

[普通按钮](#){ .md-button }

[实心按钮](#){ .md-button .md-button--primary }

[带图标按钮 :material-arrow-right:](#){ .md-button }

普通按钮

实心按钮

带图标按钮

图表¶

本站通过自定义围栏支持了不同的图表格式，包括Mermaid和GraphViz。这些图表用围栏语法包装，然后在围栏的第一行指定图表类型。围栏的内容则为图表本身的定义。

Mermaid¶

Mermaid是一种流程图、序列图和甘特图的描述语言。我们使用mermaid作为围栏的第一行来指定图表类型。例如：

可以使用的Mermaid图表类型

流程图序列图类图实体关系状态图Git图日程表

```mermaid
graph TD
    A[Hard] -->|Text| B(Round)
    B --> C{Decision}
    C -->|One| D[Result 1]
    C -->|Two| E[Result 2]
```

graph TD
    A[Hard] -->|Text| B(Round)
    B --> C{Decision}
    C -->|One| D[Result 1]
    C -->|Two| E[Result 2]

```mermaid
sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
```

sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!

```mermaid
classDiagram
    Class01 <|-- AveryLongClass : Cool
    Class03 *-- Class04
    Class05 o-- Class06
    Class07 .. Class08
    Class09 --> C2 : Where am i?
    Class09 --* C3
    Class09 --|> Class07
    Class07 : equals()
    Class07 : Object[] elementData
    Class01 : size()
    Class01 : int chimp
    Class01 : int gorilla
    Class08 <--> C2: Cool label
```

classDiagram
    Class01 <|-- AveryLongClass : Cool
    Class03 *-- Class04
    Class05 o-- Class06
    Class07 .. Class08
    Class09 --> C2 : Where am i?
    Class09 --* C3
    Class09 --|> Class07
    Class07 : equals()
    Class07 : Object[] elementData
    Class01 : size()
    Class01 : int chimp
    Class01 : int gorilla
    Class08 <--> C2: Cool label

```mermaid
erDiagram
    CUSTOMER ||--o{ ORDER : places
    ORDER ||--|{ LINE-ITEM : contains
    CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
```

erDiagram
    CUSTOMER ||--o{ ORDER : places
    ORDER ||--|{ LINE-ITEM : contains
    CUSTOMER }|..|{ DELIVERY-ADDRESS : uses

```mermaid
stateDiagram
    [*] --> First
    First --> Second
    First --> Third

    state First {
        [*] --> fir
        fir --> [*]
    }
    state Second {
        [*] --> sec
        sec --> [*]
    }
    state Third {
        [*] --> thi
        thi --> [*]
    }
```

stateDiagram
    [*] --> First
    First --> Second
    First --> Third

    state First {
        [*] --> fir
        fir --> [*]
    }
    state Second {
        [*] --> sec
        sec --> [*]
    }
    state Third {
        [*] --> thi
        thi --> [*]
    }

```mermaid
gitGraph
    commit
    branch hotfix
    checkout hotfix
    commit
    branch develop
    checkout develop
    commit id:"ash" tag:"abc"
    branch featureB
    checkout featureB
    commit type:HIGHLIGHT
    checkout main
    checkout hotfix
    commit type:NORMAL
    checkout develop
    commit type:REVERSE
    checkout featureB
    commit
    checkout main
    merge hotfix
    checkout featureB
    commit
    checkout develop
    branch featureA
    commit
    checkout develop
    merge hotfix
    checkout featureA
    commit
    checkout featureB
    commit
    checkout develop
    merge featureA
    branch release
    checkout release
    commit
    checkout main
    commit
    checkout release
    merge main
    checkout develop
    merge release
```

gitGraph
    commit
    branch hotfix
    checkout hotfix
    commit
    branch develop
    checkout develop
    commit id:"ash" tag:"abc"
    branch featureB
    checkout featureB
    commit type:HIGHLIGHT
    checkout main
    checkout hotfix
    commit type:NORMAL
    checkout develop
    commit type:REVERSE
    checkout featureB
    commit
    checkout main
    merge hotfix
    checkout featureB
    commit
    checkout develop
    branch featureA
    commit
    checkout develop
    merge hotfix
    checkout featureA
    commit
    checkout featureB
    commit
    checkout develop
    merge featureA
    branch release
    checkout release
    commit
    checkout main
    commit
    checkout release
    merge main
    checkout develop
    merge release

```mermaid
journey
    title My working day
    section Go to work
      Make tea: 5: Me
      Go upstairs: 3: Me
      Do work: 1: Me, Cat
    section Go home
      Go downstairs: 5: Me
      Sit down: 5: Me
```

journey
    title My working day
    section Go to work
      Make tea: 5: Me
      Go upstairs: 3: Me
      Do work: 1: Me, Cat
    section Go home
      Go downstairs: 5: Me
      Sit down: 5: Me

无法使用的Mermaid图表类型

甘特图饼状图

甘特图通常太大而无法在页面中正确渲染。如果元素足够大以容纳它，并且图表很大，它们会渲染得太小而无法看到。如果元素的宽度不够，图表有时会渲染得很挤，很难阅读。

```mermaid
gantt
    dateFormat  YYYY-MM-DD
    title Adding GANTT diagram to mermaid
    excludes weekdays 2014-01-10

    section A section
    Completed task            :done,    des1, 2014-01-06,2014-01-08
    Active task               :active,  des2, 2014-01-09, 3d
    Future task               :         des3, after des2, 5d
    Future task2               :         des4, after des3, 5d
```

gantt
    dateFormat  YYYY-MM-DD
    title Adding GANTT diagram to mermaid
    excludes weekdays 2014-01-10

    section A section
    Completed task            :done,    des1, 2014-01-06,2014-01-08
    Active task               :active,  des2, 2014-01-09, 3d
    Future task               :         des3, after des2, 5d
    Future task2               :         des4, after des3, 5d

饼状图有时看起来效果很好，但有时很难阅读，或者完全缺少标签。与此列表中的其他图表一样，它与大小和缩放有关。例如，如果您在移动设备上查看，您可能会看到饼图的关键部分缺失。

```mermaid
pie
    title Key elements in Product X
    "Calcium" : 42.96
    "Potassium" : 50.05
    "Magnesium" : 10.01
    "Iron" :  5
```

pie
    title Key elements in Product X
    "Calcium" : 42.96
    "Potassium" : 50.05
    "Magnesium" : 10.01
    "Iron" :  5

GraphViz¶

GraphViz是一种图形描述语言。我们使用viz作为围栏的第一行来指定图表类型。例如：

```viz
digraph "ActorLink" {
rankdir = LR
110
110 -> 111
111 -> 112
110 -> 113
113 -> 114
110 -> 115
115 -> 116
110 -> 117
117 -> 118
110 -> 119
119 -> 120

110 [label="ActorLink",comment="name: \"ActorLink\", typeName: \"\", id: 110, branchId: 0, recurseId: -1, attributes: 0, notes: \"\""];
111 [label="Actor Unique ID - A",comment="name: \"Actor Unique ID - A\", typeName: \"ActorUniqueID\", id: 111, branchId: 0, recurseId: -1, attributes: 256, notes: \"\""];
112 [label="ActorUniqueID",comment="name: \"ActorUniqueID\", typeName: \"\", id: 112, branchId: 0, recurseId: -1, attributes: 512, notes: \"\""];
113 [label="Actor Unique ID - B",comment="name: \"Actor Unique ID - B\", typeName: \"ActorUniqueID\", id: 113, branchId: 0, recurseId: -1, attributes: 256, notes: \"\""];
114 [label="ActorUniqueID",comment="name: \"ActorUniqueID\", typeName: \"\", id: 114, branchId: 0, recurseId: -1, attributes: 512, notes: \"\""];
115 [label="Link Type",comment="name: \"Link Type\", typeName: \"\", id: 115, branchId: 0, recurseId: -1, attributes: 0, notes: \"enumeration: ActorLinkType\""];
116 [label="byte",comment="name: \"byte\", typeName: \"\", id: 116, branchId: 0, recurseId: -1, attributes: 512, notes: \"\""];
117 [label="Immediate",comment="name: \"Immediate\", typeName: \"\", id: 117, branchId: 0, recurseId: -1, attributes: 0, notes: \"\""];
118 [label="bool",comment="name: \"bool\", typeName: \"\", id: 118, branchId: 0, recurseId: -1, attributes: 512, notes: \"\""];
119 [label="Passenger Initiated",comment="name: \"Passenger Initiated\", typeName: \"\", id: 119, branchId: 0, recurseId: -1, attributes: 0, notes: \"Whether the link was changed by the passenger\""];
120 [label="bool",comment="name: \"bool\", typeName: \"\", id: 120, branchId: 0, recurseId: -1, attributes: 512, notes: \"\""];
{ rank = max;112;114;116;118;120}

}
```

digraph "ActorLink" {
rankdir = LR
110
110 -> 111
111 -> 112
110 -> 113
113 -> 114
110 -> 115
115 -> 116
110 -> 117
117 -> 118
110 -> 119
119 -> 120

110 [label="ActorLink",comment="name: \"ActorLink\", typeName: \"\", id: 110, branchId: 0, recurseId: -1, attributes: 0, notes: \"\""];
111 [label="Actor Unique ID - A",comment="name: \"Actor Unique ID - A\", typeName: \"ActorUniqueID\", id: 111, branchId: 0, recurseId: -1, attributes: 256, notes: \"\""];
112 [label="ActorUniqueID",comment="name: \"ActorUniqueID\", typeName: \"\", id: 112, branchId: 0, recurseId: -1, attributes: 512, notes: \"\""];
113 [label="Actor Unique ID - B",comment="name: \"Actor Unique ID - B\", typeName: \"ActorUniqueID\", id: 113, branchId: 0, recurseId: -1, attributes: 256, notes: \"\""];
114 [label="ActorUniqueID",comment="name: \"ActorUniqueID\", typeName: \"\", id: 114, branchId: 0, recurseId: -1, attributes: 512, notes: \"\""];
115 [label="Link Type",comment="name: \"Link Type\", typeName: \"\", id: 115, branchId: 0, recurseId: -1, attributes: 0, notes: \"enumeration: ActorLinkType\""];
116 [label="byte",comment="name: \"byte\", typeName: \"\", id: 116, branchId: 0, recurseId: -1, attributes: 512, notes: \"\""];
117 [label="Immediate",comment="name: \"Immediate\", typeName: \"\", id: 117, branchId: 0, recurseId: -1, attributes: 0, notes: \"\""];
118 [label="bool",comment="name: \"bool\", typeName: \"\", id: 118, branchId: 0, recurseId: -1, attributes: 512, notes: \"\""];
119 [label="Passenger Initiated",comment="name: \"Passenger Initiated\", typeName: \"\", id: 119, branchId: 0, recurseId: -1, attributes: 0, notes: \"Whether the link was changed by the passenger\""];
120 [label="bool",comment="name: \"bool\", typeName: \"\", id: 120, branchId: 0, recurseId: -1, attributes: 512, notes: \"\""];
{ rank = max;112;114;116;118;120}

}

脚注¶

脚注用于在不打断文档流的情况下添加补充信息。脚注引用使用[^标识符]语法，标识符可以是任意字符串。脚注内容在文档中任意位置声明，但始终渲染在页面底部。例如：

这是一段带有脚注的文本[^1]，脚注也可以使用文字标识符[^note]。

[^1]: 这是第一个脚注。
[^note]:
    较长的脚注可以使用缩进的前提下另起一段。

这是一段带有脚注的文本¹，脚注也可以使用文字标识符²。

网格¶

网格用于将内容以卡片或矩形方式排列。网格需要在<div>标签中指定class="grid"（和可选的cards）和markdown特性。你也可以用HTML块快速实现<div>标签。

卡片网格¶

卡片网格将每个列表项包裹为可悬浮的卡片。使用grid和cards两个类：

/// html | div.grid.cards
- :material-file-document: __文档__ 用于记录内容
- :material-code-braces: __代码__ 用于实现功能
- :material-palette: __样式__ 用于美化界面
///

文档用于记录内容
代码用于实现功能
样式用于美化界面

通用网格¶

通用网格允许将任意块级元素排列在矩形中。只需使用grid类包裹内容即可：

/// html | div.grid

//// note | 提示1
内容1。
////

//// note | 提示2
内容2。
////

///

提示1

内容1。

提示2

内容2。

树状视图¶

树状视图是一种特殊的无序列表，需要在无序列表外面包裹<div>标签，并在<div>标签中指定class="treeview"和markdown特性。你也可以用HTML块快速实现<div>标签。例如：

/// html | div.treeview
- 根
    - 枝1
        - 叶1
        - 叶2
    - 枝2
        - 叶3
        - 叶4
///

根
- 枝1
  - 叶1
  - 叶2
- 枝2
  - 叶3
  - 叶4

工具提示¶

工具提示允许为链接和其他元素添加悬浮提示信息。链接的工具提示使用标准Markdown的标题语法即可：

[悬浮查看提示](https://example.com "这是一个工具提示！")

悬浮查看提示

对于其他元素，可以通过注入title特性来添加工具提示：

:material-information-outline:{ title="重要信息" }

此外，本站支持缩写词。缩写词的定义类似脚注，以*开头，所有匹配的文本在页面中都会显示为带有工具提示的虚线下划线。本站已通过全局缩写词表自动为所有页面添加了通用缩写词，详见includes/abbreviations.md文件。如果需要在页面中局部添加，语法如下：

HTML规范由W3C维护。

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium

HTML规范由W3C维护。

符号¶

仿照Material for MkDocs的约定，本站支持了一些符号。可用符号如下：

名称	语法	效果
版本	`<!-- md:version 1.20.0 -->` `<!-- md:version range 1.12.0 1.20.0 true false -->`	1.20.0 `1.12.0`≤＜`1.20.0`
可选	`<!-- md:optional 注释 -->`	注释
默认	`<!-- md:default none -->` `<!-- md:default computed -->` <!-- md:default `default` -->	`default`
必选	`<!-- md:flag required -->`
实验性	`<!-- md:flag experimental -->`
独有性	`<!-- md:flag china -->` `<!-- md:flag edu -->` `<!-- md:flag vanilla -->` `<!-- md:flag dev -->`

此外，还有两种快捷输出参数名的符号：

定义列表标题

/// define
<!-- md:option a.arg1 -->

- `arg1`的描述。您可以用`[arg1](#+a.arg1)`来链接到这个参数。

<!-- md:option b.arg2 -->

- `arg2`的描述。您可以用`[arg2](#+b.arg2)`来链接到这个参数。

///

arg1: arg1的描述。您可以用[arg1](#+a.arg1)来链接到这个参数。
arg2: arg2的描述。您可以用[arg2](#+b.arg2)来链接到这个参数。

#### <!-- md:setting a.arg1 -->

- `arg1`的描述。您可以用`[arg1][a.arg1]`来链接到这个参数。

#### <!-- md:setting b.arg2 -->

- `arg2`的描述。您可以用`[arg2][b.arg2]`来链接到这个参数。

`arg1`¶

arg1的描述。您可以用[arg1][a.arg1]来链接到这个参数。

`arg2`¶

arg2的描述。您可以用[arg2][b.arg2]来链接到这个参数。

还可以通过example符号指定示例的页面链接和下载链接：

<!-- md:version 1.20.0 --> <!-- md:optional 注释 --> <!-- md:example example -->

1.20.0 注释 .zip

默认的表格是不可排序的。使用sortable符号可以指定表格为可排序表格：

| 方法       | 描述                        |
|----------|---------------------------|
| `GET`    | :material-check:     获取资源 |
| `PUT`    | :material-check-all: 更新资源 |
| `DELETE` | :material-close:     删除资源 |

<!-- md:sortable -->

方法	描述
`GET`	获取资源
`PUT`	更新资源
`DELETE`	删除资源

注意，强烈建议放在表格紧挨着的下一行，或至少放在下一个表格出现之前，否则当前表格将无法变更为可排序表格，取而代之的是其他表格会应用该功能。

你可以使用samp符号来表示需要等宽显示但其本身不是代码的文本：

<!-- md:samp typewriter_text -->和`code_text`皆是等宽的。

typewriter_text和code_text皆是等宽的。

换言之，samp的作用是显示语义等宽文本而非字面等宽文本，例如：docs文件夹的名称是docs，而不是typewriter_text。

嵌入文件¶

可以使用--8<--在文章中任意位置嵌入Markdown文件。例如：

--8<-- "example.md"

该文件是示例文件。该文件位于includes/example.md。该文件自我描述了自身。请勿删除该文件。

更多关于嵌入文件的信息可以参考Snippets扩展文档。本站嵌入文件的默认基路径是includes/。

模板¶

仿照维基文本的模板语法，本站支持了模板。模板是通过内联实现的，语法如下：

{{模板名|参数1|参数2|赋值参数1=值1|赋值参数2=值2|...}}

`samp`¶

{{samp}}用于等宽显示文本，是前文介绍的samp符号的一种等效替代，例如：

{{samp|text}}

text

`nbt`与`json`¶

{{nbt}}和{{json}}用于NBT标签和JSON字段，通常配合树状视图使用，例如：

/// html | div.treeview
- {{json|object|minecraft:crafting_table}}：根对象。
    - {{json|string|table_name}}：定义合成界面显示的标题。
    - {{json|array|crafting_tags|required=1}}：定义合成配方的标签，最多64个元素。定义的标签将用于配方JSON文件中确定该配方可用的范围。
        - 4
    - {{nbt|int|Health|required=1|existonsave=1}}：这是一个序列化和反序列化都必须存在的NBT标签。
    - 6
///

minecraft:crafting_table：根对象。
- table_name：定义合成界面显示的标题。
- *crafting_tags：定义合成配方的标签，最多64个元素。定义的标签将用于配方JSON文件中确定该配方可用的范围。
  - 4
- *
  *Health：这是一个序列化和反序列化都必须存在的NBT标签。
- 6

其中，第一个参数是类型，第二个参数是键名。参数还可以指定required和existonsave属性，分别表示序列化和反序列化时是否必须存在和是否在保存时存在。

`file`¶

{{file}}用于显示文件图标和文件名，例如：

{{file|example.md}}

example.md

该模板会自动根据文件扩展名显示相应的图标。但是你也可以手动指定图标：

{{file|example.md|mp3}}

example.md

带有前缀.的文件会自动判定为隐藏文件，你也可以用hide手动指定文件是否隐藏（前两个参数必须已经设置）：

{{file|.example.md}}

{{file|example.md|md|hide=1}}

.example.md

example.md

`video`¶

{{video}}用于显示一个视频播放器，目前只支持YouTube视频，格式为{{video|youtube|视频ID}}。

这是第一个脚注。 ↩
较长的脚注可以使用缩进的前提下另起一段。 ↩

如何贡献¶

构建与编辑文档¶

文档语法¶

一般内联语法¶

注入特性¶

围栏¶

内容块¶

警告块¶

HTML块¶

定义列表¶

标签组¶

图注表注¶

注解¶

公式¶

图片¶

按钮¶

图表¶

Mermaid¶

GraphViz¶

脚注¶

网格¶

卡片网格¶

通用网格¶

树状视图¶

工具提示¶

符号¶

arg1¶

arg2¶

嵌入文件¶

模板¶

samp¶

nbt与json¶

file¶

video¶

`arg1`¶

`arg2`¶

`samp`¶

`nbt`与`json`¶

`file`¶

`video`¶