输出键
在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[n].path |
指定输出文件写入的目标位置。参见文件系统提供程序和路径以及存档提供程序和路径。 |
否 |
destinations[n].provider |
指定Antora用于发布站点的传输协议。接受内置的fs或 |
否 |
在使用默认提供程序或在 |
否 |