Antora Playbook

Antora 剧本使技术编写者可以轻松地控制站点中包含的内容、应用于站点的用户界面(UI)以及使用剧本文件发布站点的位置。playbook 文件中的设置，结合 CLI 选项和环境变量，告诉 Antora 如何操作。

具体来说，剧本告诉 Antora：

此外，可以使用 CLI选项 或 环境变量 覆盖剧本文件中的某些设置，这允许操作团队为特定环境(如生产环境)定制行为。

剧本通常位于剧本项目中。剧本项目存储库负责生成文档站点。严格来说，它是一个作为代码存储库的配置，它不包含任何内容。相反，它包含一个剧本文件，在某些情况下，还包含补充的 UI 文件和扩展代码。

剧本可以用 YAML、JSON 和 TOML 编写。YAML 是一种用于定义自动化任务的通用配置语言，本文档中的大多数剧本示例都使用 YAML 。但是您可以自由使用这些格式中的任何一种。

无论其格式如何，剧本都包含用于指定一般站点属性、内容和 UI 输入源以及发布的输出目的地和提供程序的结构化键值对。

默认情况下，Antora 在 Playbook 中解析相对路径时会从当前工作目录开始。例如，路径 public 实际上为 $PWD/public 。如果您希望 Antora 从 Playbook 文件所在的目录中解析相对路径，则在路径前面加上 ./ （例如，./public ）。

通过使用 ./ 开头的相对路径，可以使 Playbook 更具可移植性。这意味着您可以从文件系统上的任何目录运行 antora 命令，并且其行为将是相同的。

如果不使用 ./ 开头的相对路径，则 Antora 解析的路径取决于当前工作目录。要获得可移植的行为，您必须在运行 antora 命令之前切换到 Playbook 文件所在的目录。

仅在打算将路径与当前工作目录绑定在一起时才使用裸的相对路径。