约定¶

本节解释了本文件中使用的几种约定。

符号¶

本文件使用一些符号进行说明。在继续阅读之前，请确保您已熟悉以下约定列表：

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

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

某些默认值不是设置为静态值，而是从其他值计算得出，例如网站语言、代码库提供者或其他设置。

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

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

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

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

某些较新的功能仍被视为实验性，这意味着它们可能（虽然很少）在任何时候发生变化，包括完全删除（目前尚未发生）。

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

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

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

该符号表示所描述的内容是作者必须添加的自定义内容。

除了插件，还有一些工具在 MkDocs 之上构建，以提供扩展功能，例如支持版本控制。