From fdd2a9abe83119b91ecf8bf283a6186543d51317 Mon Sep 17 00:00:00 2001
From: Johannes Marbach <n0-0ne+github@mailbox.org>
Date: Fri, 6 Mar 2026 15:12:39 +0100
Subject: [PATCH] Add page search widget

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
---
 .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" -}}
 <link rel="preload" href="{{ $inter.RelPermalink }}" as="style">
 <link rel="stylesheet" href="{{ $inter.RelPermalink }}">
+
+{{/* Load Pagefind stuff to power the page search. */}}
+<link href="/pagefind/pagefind-ui.css" rel="stylesheet">
+<script src="/pagefind/pagefind-ui.js"></script>
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 @@
         </a>
       </li>
       {{ end -}}
+      <li class="nav-item" id="search-button">
+        <a class="nav-link" href="#" role="button">Search</a>
+      </li>
+      <script>
+        document.querySelector("#search-button").addEventListener("click", (event) => {
+          const search = document.querySelector("#search");
+
+          if (search.style.display === "block") {
+            // Hide the search widget.
+            search.style.display = "none";
+          } else {
+            // Initialise the search widget if needed.
+            if (!search.innerHTML.length) {
+              new PagefindUI({ element: "#search", showSubResults: true });
+            }
+
+            // Unhide and focus the search widget.
+            search.style.display = "block";
+            search.querySelector("input").focus();
+          }
+        });
+      </script>
       {{ if .Site.Params.versions -}}
       <li class="nav-item dropdown d-none d-lg-block td-navbar__version-menu">
         {{ 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 @@
           </aside>
           <main class="col-12 col-md-9 col-xl-8 ps-md-5" role="main">
             {{ partial "version-banner.html" . }}
+            <div id="search"></div>
             {{ if not (.Param "ui.breadcrumb_disable") -}}
               {{ partial "breadcrumb.html" . -}}
             {{ end -}}