开启扩展

默认情况下,如果在 playbook 文件中注册扩展,Antora 会自动启用它。只根据请求启用扩展的一种方法是使用 CLI 选项 (--extension) 指定。不过,仅凭这一点并不能提供配置键或影响加载顺序。这就是扩展启用发挥作用的地方。

您可以在 playbook 文件中注册扩展以及可选配置,然后告诉 Antora 不要启用它。然后,您可以使用 CLI 选项(--extension)启用它,它将按照播放书中列出的顺序相对于其他扩展进行注册。

要防止 Antora 启用在 playbook 文件中指定的扩展,可将预定义配置键 enabled 设置为 false。当 Antora 发现 enabled 键值为 false 时,就不会注册扩展。

Example 1. An extension that is not enabled
antora:
  extensions:
  - require: ./my-extension.js
    enabled: false
    custom: value

你可以使用 enabled 键来快速关闭扩展,而不必将其从 playbook 中移除。但更有可能的是,你这样标记它是为了使用 CLI 选项启用它。不过,要做到这一点,你需要一种方法来引用它。这就是预定义配置键 id 的作用。id 键指定了一个值,你可以使用 --extension CLI 选项来启用在 playbook 文件中标记为未启用的扩展。

首先,给我们的扩展一个 ID:

Example 2. An extension with an ID that is not enabled
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 无法找到 ID 与 --extension CLI 选项值相匹配的条目,它就会将该值视为 require 请求。