预览您的站点

在本页面,您将学到:

  • 如何在本地预览站点。

  • 如何运行一个可选的本地服务器以在本地预览站点。

本地站点预览

由于Antora生成静态站点,您无需将站点发布到Web服务器上即可查看它。Antora生成的站点可以通过浏览器的本地文件协议正常工作。Antora站点的这一特性是预览您的工作的重要工具。

要在本地查看站点,请在浏览器中导航到目的地文件夹中的任何HTML页面。如果您正在使用演示,请查找项目中的文件build/site/index.html。您将通过浏览器的文件协议查看HTML页面,可以在地址栏中看到。

运行本地服务器(可选)

虽然站点可以在没有Web服务器的情况下查看,但您可能仍然需要通过Web服务器查看站点以测试某些功能,例如索引化URL、缓存或在文件协议下无法工作的脚本。您可以使用http-server包来实现这一目的。http-server是一个简单的、用于Node.js的静态Web服务器。

使用http-server的最简单方法是使用npx调用它:

demo-site $ npx http-server -v

如果您愿意,也可以使用npm全局安装该包。

demo-site $ npm i -g http-server

这会将同名命令添加到您的PATH中,因此您无需在其前面加上npx。在本教程中,我们假设您使用npx调用http-server

现在,通过将其指向生成站点的位置来启动Web服务器。在终端中,键入命令名称npx http-server,后跟生成站点的位置(即输出目录)。我们还建议添加-c-1标志以禁用缓存。

demo-site $ npx http-server build/site -c-1

启动命令后,Web服务器的本地地址将显示在您的终端中。您应该在终端中看到以下输出:

Starting up http-server, serving build/site
Available on:
  http://127.0.0.1:8080
  http://192.168.1.8:8080
Hit CTRL-C to stop the server

将提供的第一个URL粘贴到浏览器的地址栏中,通过本地Web服务器查看您的站点。

按下Ctrl+C停止服务器。

如果在启动服务器时遇到端口冲突(即,listen EADDRINUSE: address already in use),您可以使用-p <port>选项切换到另一个端口。例如,将-p 5000附加到命令以切换到端口5000。
demo-site $ npx http-server build/site -c-1 -p 5000