输出键

output下配置的playbook键定义了站点文件的写入位置,并控制它们的处理方式。

输出键

output键包含常见的输出设置和目的地规范列表。

示例1. antora-playbook.yml
output: (1)
  clean: true (2)
  dir: ./public (3)
  destinations: (4)
  - provider: archive (5)
    path: ./public/blue.zip (6)
1 可选的output
2 可选的clean
3 可选的dir
4 可选的destinations
5 可选的provider
6 可选的path

output键及其可以接受的键值对是可选的。当playbook中未设置output时,Antora将使用fs提供程序,并默认将站点发布到输出目录build/site

目的地和提供程序键

output键接受destinations键及其嵌套的键值对列表。当您想要将站点文件发布为存档、使用自定义提供程序或将站点发布到多个目的地时,需要destinations键。

destinations键接受一个规范列表,告诉Antora应该使用哪些提供程序来发布站点以及生成的文件应该保存在哪里。当设置了destinations时,必须在其下定义一个或多个provider键。

提供程序确定Antora在发布站点时应使用哪种传输协议(本地、SSH、HTTP等),并管理发布的底层细节。Antora有两个内置提供程序,fs(文件系统)和archive(ZIP存档)。provider也是一个可以用于委托到自定义提供程序(如SSH、S3等)的扩展点。

禁用站点发布

要完全禁用发布站点文件,包括到默认输出目录的发布,请将destinations设置为空数组([])。

可用的输出键

输出键 描述 必需

clean, destinations[n].clean

当设置为true时,clean键会在生成站点之前递归地删除输出目录或文件系统提供程序路径。

destinations[n].path

指定输出文件写入的目标位置。参见文件系统提供程序和路径以及存档提供程序和路径

destinations[n].provider

指定Antora用于发布站点的传输协议。接受内置的fsarchive值。也可以指定自定义提供程序。在destinations下可以指定多个提供程序。

dir

在使用默认提供程序或在destinations下指定的第一个fs提供程序发布站点时,指定一个输出目录。