公约

¥Conventions

本节解释了本文档中使用的几个约定。

¥This section explains several conventions used in this documentation.

符号

¥Symbols

本文档使用了一些符号以便于理解。继续阅读之前，请确保您已熟悉以下约定：

¥This documentation use some symbols for illustration purposes. Before you read on, please make sure you've made yourself familiar with the following list of conventions:

– 仅限赞助商

¥ – Sponsors only

跳动的心形符号表示特定功能或行为仅供推荐人通过Insiders使用。如果您想使用该功能，请确保您拥有Insiders访问权限。

¥The pumping heart symbol denotes that a specific feature or behavior is only available to sponsors via Insiders. Make sure that you have access to Insiders if you want to use the feature.

- 版本

¥ – Version

标签符号与版本号一起表示特定功能或行为的添加时间。如果您想使用此功能或行为，请确保您至少使用此版本。

¥The tag symbol in conjunction with a version number denotes when a specific feature or behavior was added. Make sure you're at least on this version if you want to use it.

– 版本（内部人员）

¥ – Version (Insiders)

带有心形和版本号的标签符号表示在Insiders版本的 Material for MkDocs 中添加了特定的功能或行为。

¥The tag symbol with a heart in conjunction with a version number denotes that a specific feature or behavior was added to the Insiders version of Material for MkDocs.

– 默认值

¥ – Default value

mkdocs.yml中的某些属性在作者未明确定义时具有默认值。属性的默认值始终包含在内。

¥Some properties in mkdocs.yml have default values for when the author does not explicitly define them. The default value of the property is always included.

– 默认值

¥ – Default value is computed

一些默认值不是设置为静态值，而是根据其他值计算得出的，例如站点语言、存储库提供商或其他设置。

¥Some default values are not set to static values but computed from other values, like the site language, repository provider, or other settings.

– 默认值

¥ – Default value is empty

某些属性不包含默认值。这意味着，除非明确启用，否则与它们关联的功能不可用。

¥Some properties do not contain default values. This means that the functionality that is associated with them is not available unless explicitly enabled.

– 元数据属性

¥ – Metadata property

这个符号表示所描述的事物是一个元数据属性，可以在 Markdown 文档中用作前置内容定义的一部分。

¥This symbol denotes that the thing described is a metadata property, which can be used in Markdown documents as part of the front matter definition.

– 多个实例

¥ – Multiple instances

此符号表示该插件支持多个实例，即它可以在mkdocs.yml中的plugins设置中多次使用。

¥This symbol denotes that the plugin supports multiple instances, i.e, that it can be used multiple times in the plugins setting in mkdocs.yml.

– 可选功能

¥ – Optional feature

大多数功能都隐藏在功能标志后面，这意味着必须通过mkdocs.yml显式启用它们。这允许存在潜在的正交功能。

¥Most of the features are hidden behind feature flags, which means they must be explicitly enabled via mkdocs.yml. This allows for the existence of potentially orthogonal features.

– 实验

¥ – Experimental

一些较新的功能仍被视为实验性的，这意味着它们可能（尽管很少）随时发生变化，包括完全删除（目前还没有发生）。

¥Some newer features are still considered experimental, which means they might (although rarely) change at any time, including their complete removal (which hasn't happened yet).

– 插件

¥ – Plugin

通过 MkDocs 出色的插件架构实现了多项功能，其中一些功能是内置的，并与 Material for MkDocs 一起分发，因此无需安装。

¥Several features are implemented through MkDocs excellent plugin architecture, some of which are built-in and distributed with Material for MkDocs, so no installation is required.

– Markdown 扩展

¥ – Markdown extension

这个符号表示所描述的东西是一个 Markdown 扩展，可以在mkdocs.yml中启用并为 Markdown 解析器添加额外的功能。

¥This symbol denotes that the thing described is a Markdown extension, which can be enabled in mkdocs.yml and adds additional functionality to the Markdown parser.

– 必需值

¥ – Required value

一些（实际上很少）属性或设置是必需的，这意味着作者必须明确定义它们。

¥Some (very few in fact) properties or settings are required, which means the authors must explicitly define them.

– 定制

¥ – Customization

此符号表示所描述的事物是必须由作者添加的定制。

¥This symbol denotes that the thing described is a customization that must be added by the author.

- 公用事业

¥ – Utility

除了插件之外，还有一些基于 MkDocs 构建的实用程序，以提供扩展功能，例如对版本控制的支持。

¥Besides plugins, there are some utilities that build on top of MkDocs in order to provide extended functionality, like for example support for versioning.