From e6802e5630a8be5d04a9a3a9705798ec62a1477d Mon Sep 17 00:00:00 2001
From: Ian Chamberlain <ian.h.chamberlain@gmail.com>
Date: Fri, 27 Mar 2026 23:50:17 -0700
Subject: [PATCH 1/2] Implement a page search URL

There are two pieces to this:
- Prefill and execute search when a page loads with the `search` param set
- Update the URL bar when a search is executed, with 500ms debounce
---
 .vuepress/client.js                   |  4 +++
 .vuepress/components/URLDocSearch.vue | 46 +++++++++++++++++++++++++++
 2 files changed, 50 insertions(+)
 create mode 100644 .vuepress/components/URLDocSearch.vue

diff --git a/.vuepress/client.js b/.vuepress/client.js
index 30391c6b5d8..6c9e56bf648 100755
--- a/.vuepress/client.js
+++ b/.vuepress/client.js
@@ -10,6 +10,7 @@ import BlogPosts from './components/BlogPosts.vue';
 import JumpToc from './components/JumpToc.vue';
 import PrBy from './components/PrBy.vue';
 import ReleaseToc from './components/ReleaseToc.vue';
+import URLDocSearch from './components/URLDocSearch.vue';
 
 export default defineClientConfig({
   enhance({ app }) {
@@ -18,5 +19,8 @@ export default defineClientConfig({
     app.component('JumpToc', JumpToc);
     app.component('PrBy', PrBy);
     app.component('ReleaseToc', ReleaseToc);
+
+    // Override the builtin searchbox
+    app.component('SearchBox', URLDocSearch);
   },
 });
diff --git a/.vuepress/components/URLDocSearch.vue b/.vuepress/components/URLDocSearch.vue
new file mode 100644
index 00000000000..5d6a8a60207
--- /dev/null
+++ b/.vuepress/components/URLDocSearch.vue
@@ -0,0 +1,46 @@
+<template>
+  <DocSearch :options="docsearchOptions" />
+</template>
+
+<script setup lang="ts">
+import { DocSearch } from '@vuepress/plugin-docsearch/client';
+import { useDebounceFn, useEventListener } from '@vueuse/core';
+import { onMounted, onUnmounted, ref } from 'vue';
+import { useRouter, useRoute } from 'vue-router';
+
+const SEARCH_KEY = 'search';
+const docsearchOptions = ref({});
+const router = useRouter();
+const route = useRoute();
+
+// Handle initial search query, if one is set
+onMounted(() => {
+  const query = new URL(window.location.href).searchParams.get(SEARCH_KEY);
+  if (query) {
+    docsearchOptions.value.initialQuery = query;
+    document.querySelector('.DocSearch-Button').click();
+  }
+});
+
+// There's some debounce builtin to docsearch, this mimics that and should
+// help prevent browser history from getting filled with partial queries.
+const inputHandler = useDebounceFn(handleSearchInput, 500);
+useEventListener('input', inputHandler);
+
+// Update the URL bar when the search input changes.
+function handleSearchInput(event) {
+  const searchQuery = event.target.value;
+
+  if (event.target.id !== 'docsearch-input' || !searchQuery) {
+    return;
+  }
+
+  // If we had already started a search, replace it instead of appending
+  const { path, query: routeQuery } = route;
+  const replace = routeQuery?.hasOwnProperty(SEARCH_KEY);
+  const query = { ...routeQuery }; // NOTE: must copy the query object
+  query[SEARCH_KEY] = searchQuery;
+
+  router.push({ path, query: { ...query }, replace });
+}
+</script>

From 9379bdcb2d8c5e3c3f696be7616317c329320281 Mon Sep 17 00:00:00 2001
From: Ian Chamberlain <ian.h.chamberlain@gmail.com>
Date: Sat, 28 Mar 2026 01:21:36 -0700
Subject: [PATCH 2/2] Add opensearch XML for automatic search engine

Also fixup some TS lint errors in the new component, language server
wasn't working before.
---
 .vuepress/components/URLDocSearch.vue | 18 +++++++++---------
 .vuepress/config.js                   |  9 +++++++++
 .vuepress/public/opensearch.xml       | 12 ++++++++++++
 3 files changed, 30 insertions(+), 9 deletions(-)
 create mode 100644 .vuepress/public/opensearch.xml

diff --git a/.vuepress/components/URLDocSearch.vue b/.vuepress/components/URLDocSearch.vue
index 5d6a8a60207..20cd3790266 100644
--- a/.vuepress/components/URLDocSearch.vue
+++ b/.vuepress/components/URLDocSearch.vue
@@ -3,13 +3,13 @@
 </template>
 
 <script setup lang="ts">
-import { DocSearch } from '@vuepress/plugin-docsearch/client';
+import { DocSearch, DocSearchOptions } from '@vuepress/plugin-docsearch/client';
 import { useDebounceFn, useEventListener } from '@vueuse/core';
-import { onMounted, onUnmounted, ref } from 'vue';
+import { onMounted, Ref, ref } from 'vue';
 import { useRouter, useRoute } from 'vue-router';
 
 const SEARCH_KEY = 'search';
-const docsearchOptions = ref({});
+const docsearchOptions: Ref<DocSearchOptions> = ref({});
 const router = useRouter();
 const route = useRoute();
 
@@ -18,20 +18,20 @@ onMounted(() => {
   const query = new URL(window.location.href).searchParams.get(SEARCH_KEY);
   if (query) {
     docsearchOptions.value.initialQuery = query;
-    document.querySelector('.DocSearch-Button').click();
+    (document.querySelector('.DocSearch-Button') as HTMLButtonElement).click();
   }
 });
 
 // There's some debounce builtin to docsearch, this mimics that and should
 // help prevent browser history from getting filled with partial queries.
 const inputHandler = useDebounceFn(handleSearchInput, 500);
-useEventListener('input', inputHandler);
+useEventListener('input', (event) => inputHandler(event as InputEvent));
 
 // Update the URL bar when the search input changes.
-function handleSearchInput(event) {
-  const searchQuery = event.target.value;
-
-  if (event.target.id !== 'docsearch-input' || !searchQuery) {
+function handleSearchInput(event: InputEvent) {
+  const target = event.target as HTMLInputElement | undefined;
+  const searchQuery = target?.value;
+  if (target?.id !== 'docsearch-input' || !searchQuery) {
     return;
   }
 
diff --git a/.vuepress/config.js b/.vuepress/config.js
index b7dec6d00b1..bb256454d1c 100755
--- a/.vuepress/config.js
+++ b/.vuepress/config.js
@@ -110,6 +110,15 @@ export default defineUserConfig({
       { name: 'apple-mobile-web-app-status-bar-style', content: 'black' },
     ],
     ['link', { rel: 'icon', href: '/icon.png' }],
+    [
+      'link',
+      {
+        rel: 'search',
+        type: 'application/opensearchdescription+xml',
+        title: 'Nushell Docs', // NOTE: must match ShortName
+        href: '/opensearch.xml',
+      },
+    ],
   ],
   markdown: {
     importCode: {
diff --git a/.vuepress/public/opensearch.xml b/.vuepress/public/opensearch.xml
new file mode 100644
index 00000000000..25ea0573de1
--- /dev/null
+++ b/.vuepress/public/opensearch.xml
@@ -0,0 +1,12 @@
+<OpenSearchDescription
+  xmlns="http://a9.com/-/spec/opensearch/1.1/"
+  xmlns:moz="http://www.mozilla.org/2006/browser/search/"
+>
+  <ShortName>Nushell Docs</ShortName>
+  <Description>Search Nushell documentation</Description>
+  <InputEncoding>UTF-8</InputEncoding>
+  <Image width="16" height="16" type="image/png">https://www.nushell.sh/icon.png</Image>
+  <Url type="text/html" template="https://www.nushell.sh/?search={searchTerms}" />
+  <Url type="application/opensearchdescription+xml" rel="self" template="https://www.nushell.sh/opensearch.xml" />
+  <!-- TODO: it might be possible to provide suggestions via some Algolia API? -->
+</OpenSearchDescription>