缓存目录

当Antora首次运行时,它会缓存任何远程内容源git仓库和UI包。在后续运行中,Antora将从缓存文件夹中解析这些资源,有效地离线运行。

默认缓存目录

除非使用cache_dir键配置了替代位置,否则远程资源将存储在Antora的默认缓存位置。缓存的默认位置因操作系统而异。

Linux

$XDG_CACHE_HOME/antora 或者如果未设置$XDG_CACHE_HOME,则为$HOME/.cache/antora

macOS

$HOME/Library/Caches/antora

Windows

$APPDATA/antora/Caches

在下载远程资源之前,Antora将首先在缓存文件夹中查找这些资源。如果要更新缓存,请配置Antora来获取更新。另一种选择是找到系统上的Antora缓存目录并手动删除它。

cache_dir键

可选的cache_dir键在playbook中的runtime键下配置。 cache_dir指定应克隆远程存储库和下载远程UI包的目录。它接受相对或绝对文件系统路径。

示例1. antora-playbook.yml
runtime:
  cache_dir: ./.cache/antora

在这种情况下,该值解析为相对于playbook文件位置的文件夹.cache/antora。我们知道解析的位置是相对于playbook文件的,因为它以./开头。

cache_dir的解析规则与playbook中任何路径的规则相同。相对路径将使用以下规则扩展为绝对路径:

  • 如果第一个路径段是波浪号(~),则剩余路径相对于用户的主目录解析。

  • 如果第一个路径段是点号(.),则剩余路径相对于playbook文件的位置解析。

  • 如果第一个路径段是波浪号直接跟着加号(~+),或者不以前述前缀开头,则剩余路径相对于当前工作目录解析。

可以使用CLI从命令行配置缓存目录,使用--cache-dir选项或使用ANTORA_CACHE_DIR变量