内置组插件¶

组插件允许将插件分组为逻辑单元，以便根据特定环境有条件地启用或禁用它们，使用环境变量，例如，仅在持续集成（CI）时构建您的项目时启用一部分插件。

目标¶

工作原理¶

该插件仅在组启用时有条件地和惰性地加载所有属于该组的插件，这意味着当组被禁用时，该插件不会增加任何开销。这也意味着只有在组启用时，分组的插件才需要安装。

属于该组的插件按与在plugins列表中定义时相同的顺序执行。因此，顺序是保留的且是确定性的。

何时使用¶

每当您使用多个仅在特定环境中需要的插件时，例如在持续集成（CI）期间构建您的项目，该插件是简化配置的完美工具，因为它消除了将配置拆分为多个文件的需要。

它可以与任何内置或第三方插件一起使用。

配置¶

9.3.0 group – 内置

与所有内置插件一样，使用组插件非常简单。只需将以下行添加到mkdocs.yml中，并开始将插件拆分为逻辑单元：

plugins:
  - group

组插件内置于Material for MkDocs中，无需安装。

一般设置¶

以下设置可用：

enabled¶

9.3.0 false

使用此设置在构建您的项目时启用或禁用插件。该插件的行为与所有其他内置插件不同——默认情况下是禁用的。要启用组，请使用：

plugins:
  - group:
      enabled: !ENV CI # (1)!

1. 如果您只想使用组插件来更好地组织，并且始终希望启用其中的插件，请使用：

   plugins:
     - group:
         enabled: true
   

默认禁用该插件的决定是为了简化环境变量的使用，因为这消除了为环境变量提供默认值的需要。

现在，在构建您的项目时，您可以通过设置环境变量来启用组：

CI=true mkdocs build

plugins¶

9.3.0

使用此设置列出属于该组的插件。语法与plugins设置完全相同，因此您可以简单地复制要分组的插件列表，例如：

plugins:
  - group:
      plugins:
        - optimize
        - minify

这里提到的插件仅用于说明目的。