Antora Playbook

在这个页面上,您将学到:

  • Antora playbook 的目的。

  • playbook 文件的位置。

  • Antora 接受的 playbook 文件格式。

什么是 Antora playbook?

Antora playbook 让技术撰写人员可以轻松控制站点中包含的内容、应用于其上的用户界面(UI)以及使用 playbook 文件发布站点的位置。 playbook 文件中的设置,结合 CLI 选项和环境变量,告诉 Antora 如何运行。

具体来说,playbook 告诉 Antora:

此外,playbook 文件中的某些设置可以使用CLI 选项环境变量进行覆盖,这允许运维团队为特定环境(如生产环境)定制行为。

playbook 存储在哪里?

playbook 通常位于 playbook 项目中。 playbook 项目存储库负责生成文档站点。它严格是一个配置即代码存储库—它不包含任何内容。相反,它包含一个 playbook 文件,以及在某些情况下,补充的 UI 文件和扩展代码。

playbook 文件格式

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

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

playbook 中的相对路径

默认情况下,Antora 从当前工作目录解析 playbook 中的相对路径。例如,路径public实际上是$PWD/public。如果您希望 Antora 从存储 playbook 文件的目录解析相对路径,可以在路径前加上./(例如,./public)。

通过以./开头的相对路径,使您的 playbook 更具可移植性。这意味着您可以从文件系统上的任何目录运行antora命令,行为将保持一致。

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

只有当您打算将路径与当前工作目录绑定时才使用裸相对路径。