Archive Provider :: Antora Docs

存档提供程序

provider值archive将站点发布到一个ZIP文件中。

示例1. antora-playbook.yml

output:
  destinations: (1)
  - provider: archive (2)

1	`provider`键必须配置在`destinations`键下。
2	在`destinations`下，输入一个连字符（`-`）和一个空格，然后是键名`provider`，后跟一个冒号（`:`）。冒号后输入一个空格，然后是内置值名称`archive`。

除非指定path键，否则archive提供程序的默认输出目标为build/site.zip。

路径键

可选的path键指定生成的ZIP存档的目标路径和文件名。如果未指定path，Antora将使用默认的存档路径值build/site.zip。

path键接受相对或绝对文件系统路径。提供程序将根据需要创建任何中间目录。相对路径将使用以下规则扩展为绝对路径：

如果第一个路径段是波浪号（~），则剩余路径相对于用户的主目录解析。
如果第一个路径段是点号（.），则剩余路径相对于playbook文件的位置解析。
如果第一个路径段是波浪号直接跟着加号（~+），或者不以前述前缀开头，则剩余路径相对于当前工作目录解析。

指定相对路径

在示例2中，站点将发布到相对于playbook文件的目标文件blue.zip。

示例2. 将相对路径分配给路径键

output:
  destinations:
  - provider: archive
    path: ./blue.zip

指定绝对路径

在示例3中，站点将发布到/home/user/projects/launch/blue.zip，无论playbook的位置在哪里。

示例3. 将绝对路径分配给路径键

output:
  destinations:
  - provider: archive
    path: /home/user/projects/launch/blue.zip

发布到多个目的地

在示例4中，Antora正在运行位于tmp目录中的playbook文件，并将站点发布到两个位置，一个是相对路径，一个是绝对路径。

示例4. 指定多个提供程序

output:
  destinations:
  - provider: fs
    path: ./releases/red
    clean: true
  - provider: archive
    path: /home/user/projects/docs-site/blue.zip

使用fs发布的站点文件将写入目录tmp/releases/red。由于分配了clean键为true，此目录将在发布之前被删除。该站点还将作为存档发布到/home/user/projects/docs-site/blue.zip，由archive提供程序。