UI 输出目录

默认 UI 输出目录

UI 文件被发布到一个带有单个下划线标签的目录,_,相对于站点的输出目录。例如,当站点被发布到默认站点输出目录(build/site),并且没有指定 UI output_dir,UI 文件将被写入到build/site/_

output_dir 键

output_dir 键允许您指定 Antora 应该发布 UI 文件的替代目录。该路径是相对于发布站点的根目录。

示例 1. 相对 UI 输出路径
ui:
  bundle:
    url: /home/user/projects/docs-ui/build/ui-bundle-with-themes.zip
    start_path: dark
  output_dir: _/dark

在这个例子中,站点将被写入到默认目标目录,因此,UI 文件将被发布到build/site/_/dark

Antora 将自动重新配置所有对 UI 文件的引用,无论您使用什么值。这在一定程度上归功于在 UI 模板中使用的{{uiRootPath}}占位符。

在下一个示例中,除了 UI 输出目录之外,还指定了站点的输出目录(dir)。

示例 2. 自定义站点和 UI 输出目录
ui:
  bundle:
    url: /home/user/projects/docs-ui/build/ui-bundle-with-themes.zip
    start_path: dark
  output_dir: _/dark
output:
  dir: ./public

UI 文件将被发布到public/_/dark