Windows 要求

在本页中，您将了解到：

  • 如何安装 Windows 软件包管理器 Chocolatey。

  • 如何安装 Node.js。

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

Node.js

您可以在 Antora 中使用任何 Node.js 的活动 LTS 或维护 LTS 版本，但我们建议您使用最新的活动 LTS 版本，以便从最新的性能和安全增强功能中获益。https://nodejs.org/en/about/releases/[Node.js 发布时间表^] 显示了当前的 Node.js LTS 版本。

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

$ node --version

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

v16.20.0

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

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

如果 命令返回的是 Node.js LTS 运行中版本，就可以 安装 Antora 了。

安装 Chocolatey

安装 Node 版本管理器 (nvm) 和 Node.js 的最佳方法是使用 Windows 软件包管理器 Chocolatey。

  1. 打开 PowerShell 终端并以管理员身份运行，方法是右键单击 PowerShell 图标并选择 menu:以管理员身份运行[]。

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

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

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

Install nvm and Node.js

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

    如果你刚刚使用下一节中的说明安装了 Chocolatey，请使用已经打开的终端（以管理员身份运行）。

  2. 要为 Windows 安装节点版本管理器 (nvm)，请在终端中输入以下命令：

    $ choco install -y nvm

  3. 关闭终端。

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

    $ nvm install 16.20.0
    使用 nvm for Windows 时，必须输入准确的 Node.js 版本（如 16.20.0），直到 nvm-windows#214 解决为止。

现在 Node.js 已经安装完毕，您可以 安装 Antora 了。

nvm 和 CI 环境

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

$ choco install -y nodejs-lts

但是，许多 CI 环境使用 nvm 来安装用于构建作业的 Node.js 版本。通过使用 nvm，您可以将自己的设置与用于生成和发布生产网站的环境紧密结合起来。

使用 nvm 升级 Node.js

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

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

了解更多

安装 Node.js 后，就可以 安装 Antora 了。