From fdd2a9abe83119b91ecf8bf283a6186543d51317 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 6 Mar 2026 15:12:39 +0100 Subject: [PATCH 01/32] Add page search widget Signed-off-by: Johannes Marbach --- .github/workflows/main.yml | 4 ++++ assets/scss/_styles_project.scss | 6 +++++ .../internal/newsfragments/2331.feature | 1 + layouts/_partials/hooks/head-end.html | 4 ++++ layouts/_partials/navbar.html | 22 +++++++++++++++++++ layouts/docs/baseof.html | 1 + 6 files changed, 38 insertions(+) create mode 100644 changelogs/internal/newsfragments/2331.feature diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 92b841f4..706b710f 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -236,6 +236,10 @@ jobs: run: | tar -C "spec${baseURL}" --strip-components=1 -xzf openapi.tar.gz + - name: "🔍 pagefind indexing" + run: | + npx -y pagefind --site "spec${baseURL}" + - name: "📦 Tarball creation" run: | cd spec diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index cd9937a9..7a246010 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -661,3 +661,9 @@ dd { margin: 0; } } + +/* Style for page search */ +#search { + display: none; + padding-bottom: 1rem; +} \ No newline at end of file diff --git a/changelogs/internal/newsfragments/2331.feature b/changelogs/internal/newsfragments/2331.feature new file mode 100644 index 00000000..eb94a36e --- /dev/null +++ b/changelogs/internal/newsfragments/2331.feature @@ -0,0 +1 @@ +Add page search widget. diff --git a/layouts/_partials/hooks/head-end.html b/layouts/_partials/hooks/head-end.html index 2284701b..c7f3fd13 100644 --- a/layouts/_partials/hooks/head-end.html +++ b/layouts/_partials/hooks/head-end.html @@ -16,3 +16,7 @@ {{ $inter := resources.Get "css/fonts/Inter.css" -}} + +{{/* Load Pagefind stuff to power the page search. */}} + + diff --git a/layouts/_partials/navbar.html b/layouts/_partials/navbar.html index 0a563d8f..404b442a 100644 --- a/layouts/_partials/navbar.html +++ b/layouts/_partials/navbar.html @@ -61,6 +61,28 @@ {{ end -}} + + {{ if .Site.Params.versions -}}
  • {{ partial "navbar-version-selector.html" . -}} diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html index e18864dd..94e35836 100644 --- a/layouts/docs/baseof.html +++ b/layouts/docs/baseof.html @@ -49,6 +49,7 @@
    {{ partial "version-banner.html" . }} + {{ if not (.Param "ui.breadcrumb_disable") -}} {{ partial "breadcrumb.html" . -}} {{ end -}} From b3d4f9a96e754ba358258e61bd0529df3002cc22 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 17 Mar 2026 13:04:43 +0100 Subject: [PATCH 02/32] Change to using Pagefind via the built-in Docsy search UI Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 164 ++++++++++++++++++++++++++ assets/scss/_styles_project.scss | 9 +- config/_default/hugo.toml | 4 +- layouts/_partials/hooks/head-end.html | 4 - layouts/_partials/navbar.html | 22 ---- 5 files changed, 171 insertions(+), 32 deletions(-) create mode 100644 assets/js/offline-search.js diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js new file mode 100644 index 00000000..a5ce266e --- /dev/null +++ b/assets/js/offline-search.js @@ -0,0 +1,164 @@ +/* +Copyright 2026 The Matrix.org Foundation C.I.C. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +/* +Adapted from [1] to combine Docsy's built-in search UI with the Pagefind +search backend. + + [1]: https://github.com/matrix-org/docsy/blob/71d103ebb20ace3d528178c4b6d92b6cc4f7fd53/assets/js/offline-search.js +*/ + +(function ($) { + 'use strict'; + + $(document).ready(async function () { + const pagefind = await import("/pagefind/pagefind.js"); + const $searchInput = $('.td-search input'); + + // + // Lazily initialise Pagefind only when the user is about to start a search. + // + + $searchInput.focus(() => { + pagefind.init(); + }); + + // + // Register handler + // + + $searchInput.on('change', (event) => { + render($(event.target)); + + // Hide keyboard on mobile browser + $searchInput.blur(); + }); + + // Prevent reloading page by enter key on sidebar search. + $searchInput.closest('form').on('submit', () => { + return false; + }); + + // + // Pagefind + // + + const render = async ($targetSearchInput) => { + // + // Dispose existing popover + // + + { + let popover = bootstrap.Popover.getInstance($targetSearchInput[0]); + if (popover !== null) { + popover.dispose(); + } + } + + // + // Search + // + + const searchQuery = $targetSearchInput.val(); + if (searchQuery === '') { + return; + } + + const search = await pagefind.debouncedSearch(searchQuery); + if (search === null) { + // A more recent search call has been made, nothing to do. + return; + } + const results = await Promise.all(search.results.slice(0, 20).map(r => r.data())); + + // + // Make result html + // + + const $html = $('
    '); + + $html.append( + $('
    ') + .css({ + display: 'flex', + justifyContent: 'space-between', + marginBottom: '1em', + }) + .append( + $('').text('Search results').css({ fontWeight: 'bold' }) + ) + .append( + $('').addClass('td-offline-search-results__close-button') + ) + ); + + const $searchResultBody = $('
    ').css({ + maxHeight: `calc(100vh - ${ + $targetSearchInput.offset().top - $(window).scrollTop() + 180 + }px)`, + overflowY: 'auto', + }); + $html.append($searchResultBody); + + if (results.length === 0) { + $searchResultBody.append( + $('

    ').text(`No results found for query "${searchQuery}"`) + ); + } else { + results.forEach((r) => { + r.sub_results.forEach((s) => { + const href = s.url; + + const $entry = $('

    ').addClass('mt-4'); + + $entry.append( + $('').addClass('d-block text-body-secondary').text(r.meta.title) + ); + + $entry.append( + $('') + .addClass('d-block') + .css({ + fontSize: '1.2rem', + }) + .attr('href', href) + .text(s.title) + ); + + $entry.append($('

    ').html(s.excerpt)); + + $searchResultBody.append($entry); + }); + }); + } + + $targetSearchInput.one('shown.bs.popover', () => { + $('.td-offline-search-results__close-button').on('click', () => { + $targetSearchInput.val(''); + $targetSearchInput.trigger('change'); + }); + }); + + const popover = new bootstrap.Popover($targetSearchInput, { + content: $html[0], + html: true, + customClass: 'td-offline-search-results', + placement: 'bottom', + }); + popover.show(); + }; + }); +})(jQuery); diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index 7a246010..a2daa0ae 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -662,8 +662,7 @@ dd { } } -/* Style for page search */ -#search { - display: none; - padding-bottom: 1rem; -} \ No newline at end of file +/* Style for the page search widget */ +.td-offline-search-results { + max-width: 460px; +} diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml index a33f803b..8c8d9228 100644 --- a/config/_default/hugo.toml +++ b/config/_default/hugo.toml @@ -66,6 +66,7 @@ description = "Home of the Matrix specification for decentralised communication" [params] copyright = "The Matrix.org Foundation C.I.C." +offlineSearch = true [params.version] # must be one of "unstable", "current", "historical" @@ -151,7 +152,8 @@ sidebar_menu_compact = true [server.headers.values] # `style-src 'unsafe-inline'` is needed to correctly render the maths in the Olm spec: # https://github.com/KaTeX/KaTeX/issues/4096 - Content-Security-Policy = "default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self'; img-src 'self' data:; connect-src 'self'; font-src 'self' data:; media-src 'self'; child-src 'self'; form-action 'self'; object-src 'self'" + # TODO: Figure out CSP to allow loading the Pagefind Wasm + #Content-Security-Policy = "default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self'; img-src 'self' data:; connect-src 'self'; font-src 'self' data:; media-src 'self'; child-src 'self'; form-action 'self'; object-src 'self'" X-XSS-Protection = "1; mode=block" X-Content-Type-Options = "nosniff" # Strict-Transport-Security = "max-age=31536000; includeSubDomains; preload" diff --git a/layouts/_partials/hooks/head-end.html b/layouts/_partials/hooks/head-end.html index c7f3fd13..2284701b 100644 --- a/layouts/_partials/hooks/head-end.html +++ b/layouts/_partials/hooks/head-end.html @@ -16,7 +16,3 @@ {{ $inter := resources.Get "css/fonts/Inter.css" -}} - -{{/* Load Pagefind stuff to power the page search. */}} - - diff --git a/layouts/_partials/navbar.html b/layouts/_partials/navbar.html index 404b442a..0a563d8f 100644 --- a/layouts/_partials/navbar.html +++ b/layouts/_partials/navbar.html @@ -61,28 +61,6 @@

    • {{ end -}} - - {{ if .Site.Params.versions -}}
  • {{ partial "navbar-version-selector.html" . -}} From 7dfd746e068bd3f2483c1db253400b54869ec99a Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 17 Mar 2026 13:21:42 +0100 Subject: [PATCH 03/32] Remove leftovers Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 2 +- layouts/docs/baseof.html | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index a5ce266e..0a5dd267 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -34,7 +34,7 @@ search backend. $searchInput.focus(() => { pagefind.init(); - }); + }); // // Register handler diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html index 94e35836..e18864dd 100644 --- a/layouts/docs/baseof.html +++ b/layouts/docs/baseof.html @@ -49,7 +49,6 @@
    {{ partial "version-banner.html" . }} - {{ if not (.Param "ui.breadcrumb_disable") -}} {{ partial "breadcrumb.html" . -}} {{ end -}} From e679a007208187be01e07b7060b465e704e3dcd8 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 17 Mar 2026 14:16:24 +0100 Subject: [PATCH 04/32] Override search-input template Signed-off-by: Johannes Marbach --- layouts/_partials/search-input.html | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 layouts/_partials/search-input.html diff --git a/layouts/_partials/search-input.html b/layouts/_partials/search-input.html new file mode 100644 index 00000000..1b9b82e1 --- /dev/null +++ b/layouts/_partials/search-input.html @@ -0,0 +1,10 @@ +
    +
    + +
    From 9a1b7ffa7c152babf163e607b8f148bf01d3e922 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Thu, 19 Mar 2026 08:50:45 +0100 Subject: [PATCH 05/32] Group subresults Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 110 +++++++++++++++++++++++------------- 1 file changed, 72 insertions(+), 38 deletions(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index 0a5dd267..9a1f6211 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -15,18 +15,18 @@ limitations under the License. */ /* -Adapted from [1] to combine Docsy's built-in search UI with the Pagefind +Adapted from [1] to combine Docsy"s built-in search UI with the Pagefind search backend. [1]: https://github.com/matrix-org/docsy/blob/71d103ebb20ace3d528178c4b6d92b6cc4f7fd53/assets/js/offline-search.js */ (function ($) { - 'use strict'; + "use strict"; $(document).ready(async function () { const pagefind = await import("/pagefind/pagefind.js"); - const $searchInput = $('.td-search input'); + const $searchInput = $(".td-search input"); // // Lazily initialise Pagefind only when the user is about to start a search. @@ -40,7 +40,7 @@ search backend. // Register handler // - $searchInput.on('change', (event) => { + $searchInput.on("change", (event) => { render($(event.target)); // Hide keyboard on mobile browser @@ -48,7 +48,7 @@ search backend. }); // Prevent reloading page by enter key on sidebar search. - $searchInput.closest('form').on('submit', () => { + $searchInput.closest("form").on("submit", () => { return false; }); @@ -73,7 +73,7 @@ search backend. // const searchQuery = $targetSearchInput.val(); - if (searchQuery === '') { + if (searchQuery === "") { return; } @@ -88,75 +88,109 @@ search backend. // Make result html // - const $html = $('
    '); + const $html = $("
    "); $html.append( - $('
    ') + $("
    ") .css({ - display: 'flex', - justifyContent: 'space-between', - marginBottom: '1em', + display: "flex", + justifyContent: "space-between", + marginBottom: "1em", }) .append( - $('').text('Search results').css({ fontWeight: 'bold' }) + $("").text("Search results").css({ fontWeight: "bold" }) ) .append( - $('').addClass('td-offline-search-results__close-button') + $("").addClass("td-offline-search-results__close-button") ) ); - const $searchResultBody = $('
    ').css({ + const $searchResultBody = $("
    ").css({ maxHeight: `calc(100vh - ${ $targetSearchInput.offset().top - $(window).scrollTop() + 180 }px)`, - overflowY: 'auto', + overflowY: "auto", }); $html.append($searchResultBody); if (results.length === 0) { $searchResultBody.append( - $('

    ').text(`No results found for query "${searchQuery}"`) + $("

    ").text(`No results found for query "${searchQuery}"`) ); } else { - results.forEach((r) => { - r.sub_results.forEach((s) => { - const href = s.url; + results.forEach((r, index_r) => { + // Add the main result"s page title. + $searchResultBody.append( + $("") + .addClass("d-block") + .css({ + fontSize: "1.2rem", + }) + .attr("href", r.url) + .text(r.meta.title) + ); + + // Render the first 3 subresults per page and wrap the rest + // in a collapsed container. + const LIMIT = 3; + let $wrapper = null; - const $entry = $('

    ').addClass('mt-4'); + r.sub_results.forEach((s, index_s) => { + + + if (index_s === LIMIT) { + const wrapper_id = `collapssible-subresults-${index_r}`; + const $expander = $("") + .attr("data-bs-toggle", "collapse") + .attr("data-bs-target", `#${wrapper_id}`) + .attr("href", "#") + .attr("role", "button") + .attr("aria-expanded", "false") + .attr("aria-controls", wrapper_id) + .css("margin-left", "0.5rem") + .text(`${r.sub_results.length - index_s} more result(s) from ${r.meta.title}`); + + $searchResultBody.append($("

    ").append($expander)); + $wrapper = $("

    ") + .addClass("collapse") + .attr("id", wrapper_id); + $searchResultBody.append($wrapper); + } + + const $entry = $("
    ") + .css("margin-top", "0.5rem") + .css("margin-left", "0.5rem"); $entry.append( - $('').addClass('d-block text-body-secondary').text(r.meta.title) - ); - - $entry.append( - $('') - .addClass('d-block') - .css({ - fontSize: '1.2rem', - }) - .attr('href', href) + $("") + .addClass("d-block") + .attr("href", s.url) .text(s.title) ); - $entry.append($('

    ').html(s.excerpt)); + $entry.append($("

    ").html(s.excerpt)); - $searchResultBody.append($entry); + if (index_s < LIMIT) { + $searchResultBody.append($entry); + } else { + $wrapper.append($entry); + } }); }); } - $targetSearchInput.one('shown.bs.popover', () => { - $('.td-offline-search-results__close-button').on('click', () => { - $targetSearchInput.val(''); - $targetSearchInput.trigger('change'); + $targetSearchInput.one("shown.bs.popover", () => { + $(".td-offline-search-results__close-button").on("click", () => { + $targetSearchInput.val(""); + $targetSearchInput.trigger("change"); }); }); const popover = new bootstrap.Popover($targetSearchInput, { content: $html[0], html: true, - customClass: 'td-offline-search-results', - placement: 'bottom', + customClass: "td-offline-search-results", + placement: "bottom", }); popover.show(); }; From 6f05c2c78e5f879121e913c17d722901ae0b9180 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Thu, 19 Mar 2026 15:13:29 +0100 Subject: [PATCH 06/32] Improve search field placeholder Signed-off-by: Johannes Marbach --- layouts/_partials/search-input.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/layouts/_partials/search-input.html b/layouts/_partials/search-input.html index 1b9b82e1..7d4f5994 100644 --- a/layouts/_partials/search-input.html +++ b/layouts/_partials/search-input.html @@ -3,8 +3,8 @@

    From 92b7e714e7992e7bb2340add5792b74232cbeefa Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 20 Mar 2026 12:52:01 +0100 Subject: [PATCH 07/32] Add loading spinner while the search is running Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 91 ++++++++++++++++++++------------ assets/scss/_styles_project.scss | 5 ++ 2 files changed, 61 insertions(+), 35 deletions(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index 9a1f6211..8153201c 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -37,7 +37,7 @@ search backend. }); // - // Register handler + // Set up search input handler. // $searchInput.on("change", (event) => { @@ -53,12 +53,12 @@ search backend. }); // - // Pagefind + // Callback for searching and rendering the results. // const render = async ($targetSearchInput) => { // - // Dispose existing popover + // Dispose any existing popover. // { @@ -69,7 +69,7 @@ search backend. } // - // Search + // Kick off the search and collect the results. // const searchQuery = $targetSearchInput.val(); @@ -77,34 +77,61 @@ search backend. return; } + // Show the results popover with a spinner while we're busy. + const $spinner = $("
    ") + .addClass("spinner-container") + .append($("
    ") + .addClass("spinner-border") + .attr("role", "status") + .append($("
    ") + .addClass("visually-hidden") + .text("Loading..."))) + .append($("

    ") + .text("Loading...")); + const popover = new bootstrap.Popover($targetSearchInput, { + content: $spinner[0], + html: true, + customClass: "td-offline-search-results", + placement: "bottom", + }); + popover.show(); + + // Kick off the search. const search = await pagefind.debouncedSearch(searchQuery); if (search === null) { // A more recent search call has been made, nothing to do. return; } - const results = await Promise.all(search.results.slice(0, 20).map(r => r.data())); + + // Load all result details. We may want to switch to a paged UI in future for better performance. + const results = await Promise.all(search.results.slice(0, 100).map(r => r.data())); // - // Make result html + // Construct the search results html. // const $html = $("

    "); - $html.append( - $("
    ") - .css({ - display: "flex", - justifyContent: "space-between", - marginBottom: "1em", + // Add the header and close button. + $html.append($("
    ") + .css({ + display: "flex", + justifyContent: "space-between", + marginBottom: "1em", + }) + .append($("") + .text("Search results") + .css({ fontWeight: "bold" })) + .append($("") + .addClass("td-offline-search-results__close-button") + .on("click", () => { + $targetSearchInput.val(""); + $targetSearchInput.trigger("change"); }) - .append( - $("").text("Search results").css({ fontWeight: "bold" }) - ) - .append( - $("").addClass("td-offline-search-results__close-button") - ) + ) ); + // Add the main search results body. const $searchResultBody = $("
    ").css({ maxHeight: `calc(100vh - ${ $targetSearchInput.offset().top - $(window).scrollTop() + 180 @@ -119,7 +146,7 @@ search backend. ); } else { results.forEach((r, index_r) => { - // Add the main result"s page title. + // Add the main result's page title. $searchResultBody.append( $("") .addClass("d-block") @@ -136,8 +163,6 @@ search backend. let $wrapper = null; r.sub_results.forEach((s, index_s) => { - - if (index_s === LIMIT) { const wrapper_id = `collapssible-subresults-${index_r}`; const $expander = $("") @@ -179,20 +204,16 @@ search backend. }); } - $targetSearchInput.one("shown.bs.popover", () => { - $(".td-offline-search-results__close-button").on("click", () => { - $targetSearchInput.val(""); - $targetSearchInput.trigger("change"); - }); - }); - - const popover = new bootstrap.Popover($targetSearchInput, { - content: $html[0], - html: true, - customClass: "td-offline-search-results", - placement: "bottom", - }); - popover.show(); + // Finally, show the search results. + // + // Ideally we would just call setContent but there appears to be a bug in Bootstrap + // that causes the popover to be hidden when setContent is called after the popover + // has been shown. To work around this, we use the hack from [1] to inject the HTML + // content manually. + // + // [1]: https://github.com/twbs/bootstrap/issues/37206#issuecomment-1259541205 + $(popover.tip.querySelector('.popover-body')).html($html[0]); + popover.update(); }; }); })(jQuery); diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index a2daa0ae..bf2c2ba3 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -664,5 +664,10 @@ dd { /* Style for the page search widget */ .td-offline-search-results { + width: 100%; max-width: 460px; } + +.td-offline-search-results .spinner-container { + text-align: center; +} From 8e383835b96ac004ad6ff39e3074625ac8506b26 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 20 Mar 2026 13:08:53 +0100 Subject: [PATCH 08/32] Toggle expander label between show and hide Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index 8153201c..960874c8 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -165,6 +165,7 @@ search backend. r.sub_results.forEach((s, index_s) => { if (index_s === LIMIT) { const wrapper_id = `collapssible-subresults-${index_r}`; + const $action = $("").text("Show"); const $expander = $("") .attr("data-bs-toggle", "collapse") .attr("data-bs-target", `#${wrapper_id}`) @@ -173,12 +174,15 @@ search backend. .attr("aria-expanded", "false") .attr("aria-controls", wrapper_id) .css("margin-left", "0.5rem") - .text(`${r.sub_results.length - index_s} more result(s) from ${r.meta.title}`); + .append($action) + .append($("").text(` ${r.sub_results.length - index_s} more result(s) from ${r.meta.title}`)); $searchResultBody.append($("

    ").append($expander)); $wrapper = $("

    ") .addClass("collapse") - .attr("id", wrapper_id); + .attr("id", wrapper_id) + .on("hide.bs.collapse", _ => $action.text("Show")) + .on("show.bs.collapse", _ => $action.text("Hide")); $searchResultBody.append($wrapper); } From 72205be3dcedb2a50e864ce88ccf2efc7168fc6c Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 20 Mar 2026 13:13:05 +0100 Subject: [PATCH 09/32] Set cursor style and a11y label on close button Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index 960874c8..bf607c43 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -124,6 +124,8 @@ search backend. .css({ fontWeight: "bold" })) .append($("") .addClass("td-offline-search-results__close-button") + .attr("role", "button") + .attr("aria-label", "Close") .on("click", () => { $targetSearchInput.val(""); $targetSearchInput.trigger("change"); From a56969149f31875e147cccfed39bbe0928b5e626 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 20 Mar 2026 13:18:36 +0100 Subject: [PATCH 10/32] Stop bluring the input Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 3 --- 1 file changed, 3 deletions(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index bf607c43..370aba83 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -42,9 +42,6 @@ search backend. $searchInput.on("change", (event) => { render($(event.target)); - - // Hide keyboard on mobile browser - $searchInput.blur(); }); // Prevent reloading page by enter key on sidebar search. From 94fca47a7d0569a7579a10c3abe0d0e9020e3b2c Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 20 Mar 2026 13:37:41 +0100 Subject: [PATCH 11/32] Add total number of subresults per main result Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index 370aba83..fae150d6 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -146,15 +146,16 @@ search backend. } else { results.forEach((r, index_r) => { // Add the main result's page title. - $searchResultBody.append( - $("") - .addClass("d-block") + $searchResultBody.append($("
    ") + .append($("") .css({ fontSize: "1.2rem", }) .attr("href", r.url) - .text(r.meta.title) - ); + .text(r.meta.title)) + .append($("") + .addClass("text-body-secondary") + .text(` – ${r.sub_results.length} result(s)`))); // Render the first 3 subresults per page and wrap the rest // in a collapsed container. From 9edb9b3e5ba6c5873f268a0ff79a8ed2529a26c7 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 20 Mar 2026 13:38:12 +0100 Subject: [PATCH 12/32] Add triangle indicator on expander buttons and remove left margins Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index fae150d6..d24d65fb 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -165,7 +165,7 @@ search backend. r.sub_results.forEach((s, index_s) => { if (index_s === LIMIT) { const wrapper_id = `collapssible-subresults-${index_r}`; - const $action = $("").text("Show"); + const $action = $("").text("▶ Show"); const $expander = $("") .attr("data-bs-toggle", "collapse") .attr("data-bs-target", `#${wrapper_id}`) @@ -173,7 +173,6 @@ search backend. .attr("role", "button") .attr("aria-expanded", "false") .attr("aria-controls", wrapper_id) - .css("margin-left", "0.5rem") .append($action) .append($("").text(` ${r.sub_results.length - index_s} more result(s) from ${r.meta.title}`)); @@ -181,14 +180,13 @@ search backend. $wrapper = $("
    ") .addClass("collapse") .attr("id", wrapper_id) - .on("hide.bs.collapse", _ => $action.text("Show")) - .on("show.bs.collapse", _ => $action.text("Hide")); + .on("hide.bs.collapse", _ => $action.text("▶ Show")) + .on("show.bs.collapse", _ => $action.text("▼ Hide")); $searchResultBody.append($wrapper); } const $entry = $("
    ") - .css("margin-top", "0.5rem") - .css("margin-left", "0.5rem"); + .css("margin-top", "0.5rem"); $entry.append( $("") From 15f36d19349a753542610615fa9673c94d5770d9 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 20 Mar 2026 13:44:11 +0100 Subject: [PATCH 13/32] Only use plural of 'results' when actually necessary Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index d24d65fb..e97742fc 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -155,7 +155,7 @@ search backend. .text(r.meta.title)) .append($("") .addClass("text-body-secondary") - .text(` – ${r.sub_results.length} result(s)`))); + .text(` – ${r.sub_results.length} ${resultsString(r.sub_results.length)}`))); // Render the first 3 subresults per page and wrap the rest // in a collapsed container. @@ -164,6 +164,7 @@ search backend. r.sub_results.forEach((s, index_s) => { if (index_s === LIMIT) { + const num_hidden_results = r.sub_results.length - index_s; const wrapper_id = `collapssible-subresults-${index_r}`; const $action = $("").text("▶ Show"); const $expander = $("") @@ -174,7 +175,7 @@ search backend. .attr("aria-expanded", "false") .attr("aria-controls", wrapper_id) .append($action) - .append($("").text(` ${r.sub_results.length - index_s} more result(s) from ${r.meta.title}`)); + .append($("").text(` ${num_hidden_results} more ${resultsString(num_hidden_results)} from ${r.meta.title}`)); $searchResultBody.append($("

    ").append($expander)); $wrapper = $("

    ") @@ -219,3 +220,11 @@ search backend. }; }); })(jQuery); + +// +// Helpers +// + +const resultsString = (n) => { + return n > 1 ? "results" : "result"; +}; From 2fd3c28a7a64b1b5d276cff3a5a47d642f030d2b Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Fri, 20 Mar 2026 12:53:45 +0000 Subject: [PATCH 14/32] Attempt to fix page jump upon expanding search results --- assets/js/offline-search.js | 2 +- assets/scss/_styles_project.scss | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index e97742fc..ebf65adf 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -179,7 +179,7 @@ search backend. $searchResultBody.append($("

    ").append($expander)); $wrapper = $("

    ") - .addClass("collapse") + .addClass("collapse td-offline-search-results__subresults") .attr("id", wrapper_id) .on("hide.bs.collapse", _ => $action.text("▶ Show")) .on("show.bs.collapse", _ => $action.text("▼ Hide")); diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index bf2c2ba3..f6a4897f 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -668,6 +668,12 @@ dd { max-width: 460px; } +.td-offline-search-results .td-offline-search-results__subresults.collapse.show { + // Prevent the first child margin from collapsing upward when Bootstrap + // finishes the collapse animation, which otherwise causes a small jump. + display: flow-root; +} + .td-offline-search-results .spinner-container { text-align: center; } From e9a29f27dce054b469fcd3cedb3ba6a71efa621a Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 20 Mar 2026 14:04:25 +0100 Subject: [PATCH 15/32] Fix CSP Signed-off-by: Johannes Marbach --- config/_default/hugo.toml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml index 8c8d9228..eae2900f 100644 --- a/config/_default/hugo.toml +++ b/config/_default/hugo.toml @@ -152,8 +152,9 @@ sidebar_menu_compact = true [server.headers.values] # `style-src 'unsafe-inline'` is needed to correctly render the maths in the Olm spec: # https://github.com/KaTeX/KaTeX/issues/4096 - # TODO: Figure out CSP to allow loading the Pagefind Wasm - #Content-Security-Policy = "default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self'; img-src 'self' data:; connect-src 'self'; font-src 'self' data:; media-src 'self'; child-src 'self'; form-action 'self'; object-src 'self'" + # `script-src 'unsafe-eval'` is needed because Pagefind relies on it to load its Wasm: + # https://github.com/Pagefind/pagefind/blob/main/docs/content/docs/hosting.md + Content-Security-Policy = "default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-eval'; img-src 'self' data:; connect-src 'self'; font-src 'self' data:; media-src 'self'; child-src 'self'; form-action 'self'; object-src 'self'" X-XSS-Protection = "1; mode=block" X-Content-Type-Options = "nosniff" # Strict-Transport-Security = "max-age=31536000; includeSubDomains; preload" From de25ba52651d2210d98d9e8413c95ea8aeb70372 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 20 Mar 2026 14:14:45 +0100 Subject: [PATCH 16/32] Document how to build the search index locally Signed-off-by: Johannes Marbach --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 0678713b..d2bf3152 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,18 @@ We use a highly customized [Docsy](https://www.docsy.dev/) theme for our generat Awesome. If you're looking at making design-related changes to the spec site, please coordinate with us in [#matrix-docs:matrix.org](https://matrix.to/#/#matrix-docs:matrix.org) before opening a PR. +## Page search + +The spec uses [Pagefind](https://pagefind.app/) to provide a page search widget. To test this locally, you'll need to generate the +search index _after_ building the static site. + +``` +hugo build && npx -y pagefind --site public && hugo serve +``` + +Note that while `hugo serve` supports hot reloading, changes made to the site content won't reflect in the search index without +rebuilding it. + ## Building the specification If for some reason you're not a CI/CD system and want to render a static version of the spec for yourself, follow the above From 1c2e58d66f0b6c791173d40ba7135cac11a4ec01 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 24 Mar 2026 10:17:37 +0100 Subject: [PATCH 17/32] Use relative path for pagefind JS Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- assets/js/offline-search.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index ebf65adf..e4f5f916 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -25,7 +25,7 @@ search backend. "use strict"; $(document).ready(async function () { - const pagefind = await import("/pagefind/pagefind.js"); + const pagefind = await import("./pagefind/pagefind.js"); const $searchInput = $(".td-search input"); // From f49668d7223c7055bbd02a2e115bc2707e9eda85 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 24 Mar 2026 10:20:31 +0100 Subject: [PATCH 18/32] Fix typo Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- assets/js/offline-search.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index e4f5f916..1aadd879 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -15,7 +15,7 @@ limitations under the License. */ /* -Adapted from [1] to combine Docsy"s built-in search UI with the Pagefind +Adapted from [1] to combine Docsy's built-in search UI with the Pagefind search backend. [1]: https://github.com/matrix-org/docsy/blob/71d103ebb20ace3d528178c4b6d92b6cc4f7fd53/assets/js/offline-search.js From 59c7282ddba193c22d6d566adf04ea2a964aa3d4 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 24 Mar 2026 10:22:03 +0100 Subject: [PATCH 19/32] Use correct pluralisation for zero results Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- assets/js/offline-search.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index 1aadd879..5acf21b7 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -226,5 +226,5 @@ search backend. // const resultsString = (n) => { - return n > 1 ? "results" : "result"; + return n === 1 ? "result" : "results"; }; From 1f5d5987541246dff07047f7ac3ce70b6ae4e341 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 24 Mar 2026 10:23:11 +0100 Subject: [PATCH 20/32] Fix typo in HTML ID Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- assets/js/offline-search.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index 5acf21b7..2bdd6402 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -165,7 +165,7 @@ search backend. r.sub_results.forEach((s, index_s) => { if (index_s === LIMIT) { const num_hidden_results = r.sub_results.length - index_s; - const wrapper_id = `collapssible-subresults-${index_r}`; + const wrapper_id = `collapsible-subresults-${index_r}`; const $action = $("").text("▶ Show"); const $expander = $("") .attr("data-bs-toggle", "collapse") From 308bcfd20eb7ccfca30f89080e802cd36698b76b Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 24 Mar 2026 10:40:46 +0100 Subject: [PATCH 21/32] Pin pagefind version Signed-off-by: Johannes Marbach --- .github/workflows/main.yml | 2 +- README.md | 2 +- package-lock.json | 159 +++++++++++++++++++++++++++++++++++++ package.json | 4 +- 4 files changed, 164 insertions(+), 3 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 706b710f..085413a4 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -238,7 +238,7 @@ jobs: - name: "🔍 pagefind indexing" run: | - npx -y pagefind --site "spec${baseURL}" + npm run pagefind -- --site "spec${baseURL}" - name: "📦 Tarball creation" run: | diff --git a/README.md b/README.md index d2bf3152..b147cc87 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ The spec uses [Pagefind](https://pagefind.app/) to provide a page search widget. search index _after_ building the static site. ``` -hugo build && npx -y pagefind --site public && hugo serve +hugo build && npm run pagefind -- --site public && hugo serve ``` Note that while `hugo serve` supports hot reloading, changes made to the site content won't reflect in the search index without diff --git a/package-lock.json b/package-lock.json index 7b606b07..54697894 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,6 +12,7 @@ "@fullhuman/postcss-purgecss": "^6.0.0", "autoprefixer": "^10.4.20", "node-fetch": "^2.6.7", + "pagefind": "^1.4.0", "postcss": "^8.4.49", "postcss-cli": "^11.0.0" } @@ -170,6 +171,90 @@ "node": ">= 8" } }, + "node_modules/@pagefind/darwin-arm64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/darwin-arm64/-/darwin-arm64-1.4.0.tgz", + "integrity": "sha512-2vMqkbv3lbx1Awea90gTaBsvpzgRs7MuSgKDxW0m9oV1GPZCZbZBJg/qL83GIUEN2BFlY46dtUZi54pwH+/pTQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@pagefind/darwin-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/darwin-x64/-/darwin-x64-1.4.0.tgz", + "integrity": "sha512-e7JPIS6L9/cJfow+/IAqknsGqEPjJnVXGjpGm25bnq+NPdoD3c/7fAwr1OXkG4Ocjx6ZGSCijXEV4ryMcH2E3A==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@pagefind/freebsd-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/freebsd-x64/-/freebsd-x64-1.4.0.tgz", + "integrity": "sha512-WcJVypXSZ+9HpiqZjFXMUobfFfZZ6NzIYtkhQ9eOhZrQpeY5uQFqNWLCk7w9RkMUwBv1HAMDW3YJQl/8OqsV0Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@pagefind/linux-arm64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/linux-arm64/-/linux-arm64-1.4.0.tgz", + "integrity": "sha512-PIt8dkqt4W06KGmQjONw7EZbhDF+uXI7i0XtRLN1vjCUxM9vGPdtJc2mUyVPevjomrGz5M86M8bqTr6cgDp1Uw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@pagefind/linux-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/linux-x64/-/linux-x64-1.4.0.tgz", + "integrity": "sha512-z4oddcWwQ0UHrTHR8psLnVlz6USGJ/eOlDPTDYZ4cI8TK8PgwRUPQZp9D2iJPNIPcS6Qx/E4TebjuGJOyK8Mmg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@pagefind/windows-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/windows-x64/-/windows-x64-1.4.0.tgz", + "integrity": "sha512-NkT+YAdgS2FPCn8mIA9bQhiBs+xmniMGq1LFPDhcFn0+2yIUEiIG06t7bsZlhdjknEQRTSdT7YitP6fC5qwP0g==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, "node_modules/@pkgjs/parseargs": { "version": "0.11.0", "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", @@ -914,6 +999,24 @@ "dev": true, "license": "BlueOak-1.0.0" }, + "node_modules/pagefind": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/pagefind/-/pagefind-1.4.0.tgz", + "integrity": "sha512-z2kY1mQlL4J8q5EIsQkLzQjilovKzfNVhX8De6oyE6uHpfFtyBaqUpcl/XzJC/4fjD8vBDyh1zolimIcVrCn9g==", + "dev": true, + "license": "MIT", + "bin": { + "pagefind": "lib/runner/bin.cjs" + }, + "optionalDependencies": { + "@pagefind/darwin-arm64": "1.4.0", + "@pagefind/darwin-x64": "1.4.0", + "@pagefind/freebsd-x64": "1.4.0", + "@pagefind/linux-arm64": "1.4.0", + "@pagefind/linux-x64": "1.4.0", + "@pagefind/windows-x64": "1.4.0" + } + }, "node_modules/path-key": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", @@ -1652,6 +1755,48 @@ "fastq": "^1.6.0" } }, + "@pagefind/darwin-arm64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/darwin-arm64/-/darwin-arm64-1.4.0.tgz", + "integrity": "sha512-2vMqkbv3lbx1Awea90gTaBsvpzgRs7MuSgKDxW0m9oV1GPZCZbZBJg/qL83GIUEN2BFlY46dtUZi54pwH+/pTQ==", + "dev": true, + "optional": true + }, + "@pagefind/darwin-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/darwin-x64/-/darwin-x64-1.4.0.tgz", + "integrity": "sha512-e7JPIS6L9/cJfow+/IAqknsGqEPjJnVXGjpGm25bnq+NPdoD3c/7fAwr1OXkG4Ocjx6ZGSCijXEV4ryMcH2E3A==", + "dev": true, + "optional": true + }, + "@pagefind/freebsd-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/freebsd-x64/-/freebsd-x64-1.4.0.tgz", + "integrity": "sha512-WcJVypXSZ+9HpiqZjFXMUobfFfZZ6NzIYtkhQ9eOhZrQpeY5uQFqNWLCk7w9RkMUwBv1HAMDW3YJQl/8OqsV0Q==", + "dev": true, + "optional": true + }, + "@pagefind/linux-arm64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/linux-arm64/-/linux-arm64-1.4.0.tgz", + "integrity": "sha512-PIt8dkqt4W06KGmQjONw7EZbhDF+uXI7i0XtRLN1vjCUxM9vGPdtJc2mUyVPevjomrGz5M86M8bqTr6cgDp1Uw==", + "dev": true, + "optional": true + }, + "@pagefind/linux-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/linux-x64/-/linux-x64-1.4.0.tgz", + "integrity": "sha512-z4oddcWwQ0UHrTHR8psLnVlz6USGJ/eOlDPTDYZ4cI8TK8PgwRUPQZp9D2iJPNIPcS6Qx/E4TebjuGJOyK8Mmg==", + "dev": true, + "optional": true + }, + "@pagefind/windows-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/windows-x64/-/windows-x64-1.4.0.tgz", + "integrity": "sha512-NkT+YAdgS2FPCn8mIA9bQhiBs+xmniMGq1LFPDhcFn0+2yIUEiIG06t7bsZlhdjknEQRTSdT7YitP6fC5qwP0g==", + "dev": true, + "optional": true + }, "@pkgjs/parseargs": { "version": "0.11.0", "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", @@ -2117,6 +2262,20 @@ "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", "dev": true }, + "pagefind": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/pagefind/-/pagefind-1.4.0.tgz", + "integrity": "sha512-z2kY1mQlL4J8q5EIsQkLzQjilovKzfNVhX8De6oyE6uHpfFtyBaqUpcl/XzJC/4fjD8vBDyh1zolimIcVrCn9g==", + "dev": true, + "requires": { + "@pagefind/darwin-arm64": "1.4.0", + "@pagefind/darwin-x64": "1.4.0", + "@pagefind/freebsd-x64": "1.4.0", + "@pagefind/linux-arm64": "1.4.0", + "@pagefind/linux-x64": "1.4.0", + "@pagefind/windows-x64": "1.4.0" + } + }, "path-key": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", diff --git a/package.json b/package.json index e1233d0c..fc6ffc43 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,8 @@ "main": "none.js", "scripts": { "get-proposals": "node ./scripts/proposals.js", - "test": "echo \"Error: no test specified\" && exit 1" + "test": "echo \"Error: no test specified\" && exit 1", + "pagefind": "pagefind $@" }, "repository": { "type": "git", @@ -22,6 +23,7 @@ "@fullhuman/postcss-purgecss": "^6.0.0", "autoprefixer": "^10.4.20", "node-fetch": "^2.6.7", + "pagefind": "^1.4.0", "postcss": "^8.4.49", "postcss-cli": "^11.0.0" } From bccbff878d6a8c8585bde19bc0bbc6546d4da404 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 24 Mar 2026 10:56:03 +0100 Subject: [PATCH 22/32] Fix relative path to pagefind script Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index 2bdd6402..924b1a5b 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -25,7 +25,9 @@ search backend. "use strict"; $(document).ready(async function () { - const pagefind = await import("./pagefind/pagefind.js"); + // This is going to be loaded from ${deployment}/js/main.js so to use a relative path + // to the Pagefind script we need to navigate one level up. + const pagefind = await import("../pagefind/pagefind.js"); const $searchInput = $(".td-search input"); // From 0cf8fca4dae1c28455768ea7e0de52f1f6142eaa Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 24 Mar 2026 10:59:39 +0100 Subject: [PATCH 23/32] Unwrap jQuery object Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index 924b1a5b..6b84ce44 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -87,7 +87,7 @@ search backend. .text("Loading..."))) .append($("

    ") .text("Loading...")); - const popover = new bootstrap.Popover($targetSearchInput, { + const popover = new bootstrap.Popover($targetSearchInput[0], { content: $spinner[0], html: true, customClass: "td-offline-search-results", From 84b5e98f255cea9028aa982e201debf21abb11cb Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 24 Mar 2026 11:07:57 +0100 Subject: [PATCH 24/32] Switch to (outline) buttons for the expander Signed-off-by: Johannes Marbach --- assets/js/offline-search.js | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js index 6b84ce44..ec79d2b6 100644 --- a/assets/js/offline-search.js +++ b/assets/js/offline-search.js @@ -169,13 +169,15 @@ search backend. const num_hidden_results = r.sub_results.length - index_s; const wrapper_id = `collapsible-subresults-${index_r}`; const $action = $("").text("▶ Show"); - const $expander = $("") + const $expander = $("