Merge fdd2a9abe8 into 252de984cc

.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

assets/scss/_styles_project.scss

@@ -661,3 +661,9 @@ dd {
     margin: 0;
   }
 }
+
+/* Style for page search */
+#search {
+  display: none;
+  padding-bottom: 1rem;
+}

changelogs/internal/newsfragments/2331.feature

@@ -0,0 +1 @@
+Add page search widget.

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>

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" . -}}

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 -}}