为本地预览构建一个UI项目

构建预览站点

一旦您修改了站点 UI ,您想要做的第一件事就是检查它的外观。这就是 preview-src/ 文件夹的作用。该文件夹包含 HTML 文件片段,提供了来自站点的代表性内容样本。预览可以避免您必须生成整个站点才能测试 UI 。这些文件应该让您了解应用于实际站点时 UI 的外观。

预览站点中的页面使用 Handlebars 模板组装,链接到预编译的资产(assets)文件(模拟站点生成器的行为)。因此,要查看它们,您需要通过 UI 构建运行它们。

有两种预览模式可用。您可以运行构建一次并检查结果,也可以持续运行构建,以便在修改时查看更改。接下来的两个部分介绍如何使用这些模式。

构建一次

要构建一次 UI 以预览,然后停止,执行以下命令:

gulp preview:build

此任务将 UI 文件预编译为 public 目录。要查看预览页面,请使用浏览器导航到 public 目录中的 HTML 页面(例如,public/index.html)。

持续构建

为了避免在开发时一遍又一遍地运行 preview:build 任务,您可以使用 preview 命令让它连续运行。该任务还启动一个本地 HTTP 服务器,以便更新与浏览器同步(即实时重新加载)。

要启动预览服务器,请执行以下命令:

gulp preview

您将在该命令的输出中看到一个 URL

[12:59:28] Starting 'preview:serve'...
[12:59:28] Starting server...
[12:59:28] Server started http://localhost:5252
[12:59:28] Running server

导航到 URL 以查看预览站点。此命令正在运行时,您对源文件所做的任何更改都将立即反映在浏览器中。这是通过监视项目的变化、在检测到更改时运行 preview:build 任务,并将更新发送到浏览器来实现的。

按 kbd:[Ctrl+C] 来停止预览服务器并结束持续构建。

用于预览的软件包

如果在本地开发中需要绑定 UI ,以便在实际站点上预览 UI ,可以执行以下命令:

gulp bundle

bundle 命令还会调用 lint 命令来检查 CSS 和 JavaScript 是否符合编码标准。

UI 捆绑包将可在 build/ui-bundle.zip 中使用。然后,您可以使用 --ui-bundle-url 命令行选项将 Antora 指向此捆绑包。

如果您正在运行预览,并且想要捆绑而不导致预览被覆盖,可以使用:

gulp bundle:pack

UI 捆绑包将再次可在 build/ui-bundle.zip 中使用。