启用扩展

默认情况下，如果在playbook文件中注册扩展，Antora将自动启用它。一种仅在请求时启用扩展的方法是使用CLI选项（--extension）指定它。然而，仅仅这样做并不能提供配置键或影响加载顺序。这就是扩展启用的作用所在。

您可以在playbook文件中注册扩展，以及可选配置，然后告诉Antora不要启用它。然后您可以使用CLI选项（--extension）来启用它，并且它将根据playbook中列出的顺序相对于其他扩展进行注册。

要防止Antora启用playbook文件中指定的扩展，请将预定义的配置键enabled设置为值false。当Antora看到enabled键的值为false时，它将不会注册该扩展。

示例1. 未启用的扩展

antora:
  extensions:
  - require: ./my-extension.js
    enabled: false
    custom: value

您可以使用enabled键快速关闭一个扩展，而无需将其从playbook中删除。更有可能的是，您以这种方式标记它，以便可以使用CLI选项启用它。但是，为了做到这一点，您需要一种引用它的方法。这就是预定义配置键id的目的。id键指定一个值，您可以使用--extension CLI选项引用它，以启用在playbook文件中标记为未启用的扩展。

首先，让我们给我们的扩展一个ID：

示例2. 带有未启用ID的扩展

antora:
  extensions:
  - id: my-extension
    require: ./my-extension.js
    enabled: false
    custom: value

现在我们可以通过CLI启用这个扩展，如下所示：

$ antora --extension=my-extension antora-playbook.yml

通常情况下，--extension CLI选项的值是一个require请求，但在启用扩展时，当您正在启用一个扩展时，该值是playbook文件中扩展条目的ID。

如果Antora找不到与--extension CLI选项的值匹配的ID条目，它将退回到将该值视为require请求的处理方式。