UI键

ui下配置的playbook键定义了UI包的位置以及控制其处理方式。

ui键

ui键指定了UI包的位置、状态、默认页面模板名称和输出目录。

示例1. antora-playbook.yml
ui: (1)
  bundle: (2)
    url: https://example.org/docs-ui/download/latest/ui-bundle.zip (3)
    snapshot: true (4)
    start_path: dark (5)
  default_layout: base (6)
  output_dir: _/dark (7)
1 必需的ui
2 必需的bundle
3 必需的url
4 可选的snapshot
5 可选的start_path
6 可选的default_layout
7 可选的output_dir

uibundleurl键是必需的。或者,url键可以从CLI中分配。如果未指定其他键,则Antora将使用它们的默认值。

可用的UI键

UI键 描述 必需的

bundle.snapshot

指示URL是否指向快照。

bundle.start_path

接受UI包内文件应该选择的路径。

bundle.url

接受指向UI包存档的URL或文件系统路径。

default_layout

将布局模板应用于未指定页面布局的页面。

output_dir

接受Antora写入已发布站点的UI文件的输出目录的文件系统路径。

supplemental_files

覆盖UI包的补充文件(也称为补充UI)。