v3.2.0

What's Changed

• feat: reach search without opening the menu on small screens by @arska in #203

Full Changelog: v3.1.0...v3.2.0

v3.1.0

What's Changed

• feat: generate an OpenSearch descriptor from the site's own configuration by @arska in #202

Full Changelog: v3.0.0...v3.1.0

v3.0.0

What's Changed

• feat: one UI, four brand bundles by @arska in #199
• chore: follow the rename to vshn/antora-ui by @arska in #200

Full Changelog: v2.8.0...v3.0.0

v2.8.0

What's Changed

• chore: stop loading Google Analytics by @arska in #198

Full Changelog: v2.7.0...v2.8.0

v2.7.0

Features

• Load the search index while the reader is reading, at an idle moment after the page, so the first search only needs the index chunk for its words. Readers whose browser asks to save data are left alone, and for them it loads when they reach for the search box. By @arska in #197
• Show five search results and fetch the rest with a "Show more results" button. Each result costs a request for its excerpt, which the sites serve over HTTP/1.1 (see #195). By @arska in #196

Fixes

• Run a search once. Typing a word and pressing Enter searched twice, once from the pause in typing and once from Enter, which roughly doubled the wait and rebuilt the results already on screen. By @arska in #197

Full Changelog: v2.6.0...v2.7.0

v2.6.0

Features

• Name the CSS and JavaScript after their content (css/site-2fddbd0b.css), and rewrite the templates that reference them. A changed file is now a different URL, so a site can cache /_/ for a long time as immutable without readers keeping an old UI after an update. Nothing outside the bundle references these files by name. By @arska in #192 (see #193 for the site-side caching)

Fixes

• Start Pagefind only once the page has finished loading. Its search worker needs the main thread for its handshake, which is busy during page load, so the handshake timed out and the search fell back to the main thread: 5.8 seconds for the first search on a real site. By @arska in #191

Build and tooling

• Generate the preview pages from the staged UI instead of the sources, so the preview renders with what ships, and wait for those pages to be written before indexing them. The page build reported itself finished while still writing, so the search index was built from a half-written site. By @arska in #192

Full Changelog: v2.5.2...v2.6.0

v2.5.2

What's Changed

• test: guard the published assets, binaries and syntax highlighting by @arska in #189
• fix: open the search results for a ?q= URL by @arska in #190

Full Changelog: v2.5.1...v2.5.2

v2.5.1

Fixes

• Store already compressed files (fonts, images) uncompressed in the bundle. v2.4.0 and v2.5.0 could not be loaded by ghcr.io/vshn/antora:3.1.14, which the documentation sites build with: it runs Node 24.17, which never finishes reading a compressed zip entry of 64 KiB or more, so Antora exited without generating any page and without an error. The bundled Font Awesome font was the first such entry. Sites on v2.4.0 or v2.5.0 should update to this release. By @arska in #188

Build and tooling

• Build a page with the bundle inside the sites' Antora image in CI, so a bundle the sites cannot load fails here first. Test that no bundle entry compresses to 64 KiB or more. By @arska in #188

Full Changelog: v2.5.0...v2.5.1

v2.5.0

Features

• Search with Pagefind, in the browser, when the site builds a Pagefind index (npx pagefind --site build/site after the Antora build). Sites without an index keep using the /search endpoint of the search engine container, so each site switches on its own schedule. Pagefind loads in the background once the reader hovers over or focuses the search box. See the README section "Search". By @arska in #178 (#177)
• Report searches to Plausible when the playbook sets site.keys.plausibleScript: Search with the normalized query and result count, and Search Result Click with the position. The script and events go through the site's own domain, so the site's nginx has to proxy /js/<script> and /api/event (see the README section "Search Analytics"). Off by default. By @arska in #185 (#181)

Fixes

• Leave out the Google Analytics tag for Universal Analytics IDs (UA-…), which Google no longer processes. kb.vshn.ch still set one. GA4 IDs (G-…) keep working. By @arska in #183
• Fix a ReferenceError after every search on sites without site.keys.searchPagePath, which also kept the ?q= URL from updating. By @arska in #178

Build and tooling

• Keep Font Awesome on v5 in Renovate, since content uses v5 icon names. Run CI for pull requests against any base branch. By @arska in #186

Full Changelog: v2.4.0...v2.5.0

v2.4.0

Fixes

• Restore Font Awesome icons without a CDN. Since 2.3.0, admonitions (NOTE, TIP, WARNING, CAUTION, IMPORTANT) showed an empty box, and icon:name[] macros, such as the check marks in the products comparison tables, rendered as nothing. Font Awesome 5 Free is now bundled and served from /_/font/, and admonition icons are inline SVGs. By @arska in #171

Tests

• Add Playwright smoke tests for the preview: icon macros, admonition icons, self-hosted fonts, a third-party request allowlist, and error-free index and 404 pages. They run in CI. By @arska in #172

Build and tooling

• Migrate to ESLint 10 flat config with neostandard, replacing gulp-eslint and prettier-eslint. Convert package-lock.json to lockfile v3 and bump gulp-stylelint to 13. By @arska in #173

Dependencies

• Update dependency gulp to v5 by @renovate[bot] in #169
• Update dependency fs-extra to v11 by @renovate[bot] in #160

Full Changelog: v2.3.3...v2.4.0