使用现有的Playbook项目

此页面适用于加入已经使用Antora的文档项目的人员。

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

在使用Antora生成站点之前，您需要获取站点的playbook项目。

获取playbook项目

首先，打开终端并使用git克隆playbook项目：

$ git clone your-playbook-repo && cd "`basename $_`"

该命令克隆现有的playbook项目，然后切换到项目文件夹。

如果项目包含一个package-lock.json文件，这意味着它要求您在本地安装Antora。要这样做，请运行以下命令：

$ npm ci

当在本地安装Antora后，您将使用npx antora来运行Antora，而不是antora。npx命令将在playbook项目或playbook项目的任何父目录中查找安装的antora命令。