Windows 系统要求

Antora 是一个可在任何 Node.js 安装上运行的便携式应用程序。由于 Node.js 是为 Windows 发布和运行的，这意味着 Antora 可在 Windows 上运行而无需任何额外要求。

在本页面上，您将学到：

  • 如何安装 Chocolatey，即 Windows 包管理器。

  • 如何安装 Node.js。

如果您以前从未安装过 Antora，则需要在安装 Antora 并用其生成文档站点之前完成本页面上的步骤。由于 Antora 建立在 Node.js 上，您需要在计算机上安装 Node.js（命令： node、npm 和 npx）才能安装和运行 Antora。

Node.js

您可以使用任何活跃的 LTS 或维护 LTS 版本的 Node.js 与 Antora 配合使用，但我们建议使用最新的活跃 LTS 版本，以便从最新的性能和安全增强功能中受益。 Node.js 发布时间表 显示了活跃的 Node.js LTS 版本。

要查看是否已安装 Node.js 以及其版本，请打开 PowerShell 并键入：

$ node --version

您应该看到一个版本字符串，例如：

v16.20.2

如果命令失败并显示错误，则表示您尚未安装 Node.js。在 Windows 上安装 Node.js 的最佳方法是使用 Chocolatey。如果您的计算机上没有安装 Chocolatey，请转到 安装 Chocolatey 进行设置。否则，直接跳转到 安装 nvm 和 Node。

如果命令返回的版本不是活跃的 LTS 版本，请升级到活跃的 Node.js LTS 版本 使用 nvm。

如果命令返回的是活跃的 Node.js LTS 版本，则您已准备好 安装 Antora。

安装 Chocolatey

使用 Chocolatey，即 Windows 的包管理器，是安装 Node Version Manager (nvm) 和 Node.js 的最佳方式。

  1. 打开 PowerShell 终端，并通过右键单击 PowerShell 图标并选择 以管理员身份运行 来以管理员身份运行。

  2. 在终端中键入以下命令：

    $ Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))

现在您已准备好安装 nvm 和 Node.js。

安装 nvm 和 Node.js

  1. 打开 PowerShell 终端，右键单击 PowerShell 图标，并选择 以管理员身份运行。

    如果您刚刚按照前面部分的说明安装了 Chocolatey，请使用相同的终端（以管理员身份运行）。

  2. 要在终端中安装 Windows 版本的 Node Version Manager (nvm)，请输入以下命令：

    $ choco install -y nvm

  3. 关闭终端。

  4. 打开一个新的常规 PowerShell 终端，并使用 nvm 安装 Node.js。

    $ nvm install 16.20.2
    在 Windows 上使用 nvm 时，您必须输入一个确切的 Node.js 版本（例如，16.20.2），直到 nvm-windows#214 得到解决。

现在 Node.js 已安装，您已准备好 安装 Antora。

nvm 和 CI 环境

您可以直接安装 Node.js 的 LTS 版本，而无需安装 nvm，只需在管理员 PowerShell 中输入以下命令：

$ choco install -y nodejs-lts

然而，许多 CI 环境使用 nvm 来安装用于构建作业的 Node.js 版本。通过使用 nvm，您可以使您的设置与用于生成和发布生产站点的环境紧密对齐。

使用 nvm 升级 Node.js

如果您已安装 nvm 但您的 Node.js 版本不是活跃的 LTS 版本，请在终端中键入以下命令：

$ nvm install 16.20.2
在 Windows 上使用 nvm 时，您必须输入完整的 Node.js 版本（即，nvm install 16.20.2）。

了解更多

一旦安装了 Node.js，您就可以准备好 安装 Antora。