内置元插件¶

元插件解决了为所有人设置元数据（前台）的问题文件夹中的页面，即项目的一个子部分，尤其是有助于确保页面的某个子集具有特定的标签，并使用或者归因于作者。

Objective¶

该插件扫描[docs目录][mkdocs.docs_dir]中的.meta.yml文件，并递归地将这些文件的内容与元数据（front 内容）包含在同一文件夹和所有子文件夹中的所有页面。例如，如果您想将标签示例添加到多个页面，使用：

.meta.yml

tags:
  - Example

现在，给定以下目录布局，如果将文件存储在文件夹中名为“example”的文件夹中的所有页面都会收到标签，而所有页面文件夹外部不受影响：

.
├─ docs/
│  ├─ ...
│  ├─ example/
│  │  ├─ .meta.yml
│  │  ├─ a.md
│  │  ├─ ...
│  │  └─ z.md
│  └─ ...
└─ mkdocs.yml

当组合元数据时，列表和字典会递归合并意味着您可以将值附加到列表中，并在列表中添加或设置特定属性任意级别的词典。

虽然插件本身除了添加和合并元数据后，它是许多其他内置元数据的完美伴侣 Material for MkDocs提供的插件。一些最强大的组合元插件和其他内置插件包括：

Built-in social plugin

The meta plugin can be used to change the layout for social cards or change specific layout options like background or color for a subset of pages.
.meta.yml
```
social:
  cards_layout: default/variant
```
Built-in blog plugin

The meta plugin allows to automatically associate blog posts with specific authors and categories, ensuring that blog posts are always correctly annotated.
.meta.yml
```
authors:
  - squidfunk
```
Built-in tags plugin

The meta plugin makes it possible to ensure that subsections of your project are annotated with specific tags, so they can't be forgotten when adding pages.
.meta.yml
```
tags:
  - Example
```
Built-in search plugin

The meta plugin makes it easy to boost specific sections in search results or to exclude them entirely from being indexed, giving more granular control over search.
.meta.yml
```
search:
  exclude: true
```

与所有[内置插件]一样，开始使用元插件是直截了当。只需将以下行添加到mkdocs.yml中，然后开始一次为多个页面应用元数据：

plugins:
  - meta

元插件包含在MkDocs的Material中，不需要安装。

以下设置可用：

使用此设置可在[构建项目]时启用或禁用插件。通常不需要指定此设置，但如果要禁用插件，使用：

plugins:
  - meta:
      enabled: false

以下设置可用于元文件：

使用此设置更改插件在以下情况下将查找的元文件名扫描[文档目录][mkdocs.docs-dir]。通常没有必要更改此设置，但如果要更改，请使用：

plugins:
  - meta:
      meta_file: .meta.yml

提供的路径是从[docs目录][mkdocs.docs_dir]解析的递归。