@docusaurus/theme-search-algolia 3.3.2 → 3.5.0

package/lib/client/useAlgoliaContextualFacetFilters.js

@@ -4,10 +4,18 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { useContextualSearchFilters } from '@docusaurus/theme-common';
-// Translate search-engine agnostic search filters to Algolia search filters
+import { DEFAULT_SEARCH_TAG } from '@docusaurus/theme-common/internal';
+import { useDocsContextualSearchTags } from '@docusaurus/plugin-content-docs/client';
+import useDocusaurusContext from '@docusaurus/core/src/client/exports/useDocusaurusContext';
+function useSearchTags() {
+    // only docs have custom search tags per version
+    const docsTags = useDocsContextualSearchTags();
+    return [DEFAULT_SEARCH_TAG, ...docsTags];
+}
+// Translate search-engine agnostic search tags to Algolia search filters
 export function useAlgoliaContextualFacetFilters() {
-    const { locale, tags } = useContextualSearchFilters();
+    const locale = useDocusaurusContext().i18n.currentLocale;
+    const tags = useSearchTags();
     // Seems safe to convert locale->language, see AlgoliaSearchMetadata comment
     const languageFilter = `language:${locale}`;
     const tagsFilter = tags.map((tag) => `docusaurus_tag:${tag}`);

package/lib/client/useAlgoliaThemeConfig.d.ts

@@ -1,3 +1,2 @@
-/// <reference path="../../src/theme-search-algolia.d.ts" />
 import type { ThemeConfig } from '@docusaurus/theme-search-algolia';
 export declare function useAlgoliaThemeConfig(): ThemeConfig;

package/lib/index.js

@@ -7,23 +7,12 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateThemeConfig = void 0;
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const eta_1 = require("eta");
+exports.default = themeSearchAlgolia;
 const utils_1 = require("@docusaurus/utils");
 const theme_translations_1 = require("@docusaurus/theme-translations");
-const opensearch_1 = tslib_1.__importDefault(require("./templates/opensearch"));
-const getCompiledOpenSearchTemplate = lodash_1.default.memoize(() => (0, eta_1.compile)(opensearch_1.default.trim()));
-function renderOpenSearchTemplate(data) {
-    const compiled = getCompiledOpenSearchTemplate();
-    return compiled(data, eta_1.defaultConfig);
-}
-const OPEN_SEARCH_FILENAME = 'opensearch.xml';
+const opensearch_1 = require("./opensearch");
 function themeSearchAlgolia(context) {
-    const { baseUrl, siteConfig: { title, url, favicon, themeConfig }, i18n: { currentLocale }, } = context;
+    const { baseUrl, siteConfig: { themeConfig }, i18n: { currentLocale }, } = context;
     const { algolia: { searchPagePath }, } = themeConfig;
     return {
         name: 'docusaurus-theme-search-algolia',
@@ -48,43 +37,18 @@ function themeSearchAlgolia(context) {
                 });
             }
         },
-        async postBuild({ outDir }) {
-            if (searchPagePath) {
-                const siteUrl = (0, utils_1.normalizeUrl)([url, baseUrl]);
-                try {
-                    await fs_extra_1.default.writeFile(path_1.default.join(outDir, OPEN_SEARCH_FILENAME), renderOpenSearchTemplate({
-                        title,
-                        siteUrl,
-                        searchUrl: (0, utils_1.normalizeUrl)([siteUrl, searchPagePath]),
-                        faviconUrl: favicon ? (0, utils_1.normalizeUrl)([siteUrl, favicon]) : null,
-                    }));
-                }
-                catch (err) {
-                    logger_1.default.error('Generating OpenSearch file failed.');
-                    throw err;
-                }
+        async postBuild() {
+            if ((0, opensearch_1.shouldCreateOpenSearchFile)({ context })) {
+                await (0, opensearch_1.createOpenSearchFile)({ context });
             }
         },
         injectHtmlTags() {
-            if (!searchPagePath) {
-                return {};
+            if ((0, opensearch_1.shouldCreateOpenSearchFile)({ context })) {
+                return { headTags: (0, opensearch_1.createOpenSearchHeadTags)({ context }) };
             }
-            return {
-                headTags: [
-                    {
-                        tagName: 'link',
-                        attributes: {
-                            rel: 'search',
-                            type: 'application/opensearchdescription+xml',
-                            title,
-                            href: (0, utils_1.normalizeUrl)([baseUrl, OPEN_SEARCH_FILENAME]),
-                        },
-                    },
-                ],
-            };
+            return {};
         },
     };
 }
-exports.default = themeSearchAlgolia;
 var validateThemeConfig_1 = require("./validateThemeConfig");
 Object.defineProperty(exports, "validateThemeConfig", { enumerable: true, get: function () { return validateThemeConfig_1.validateThemeConfig; } });

package/lib/opensearch.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { HtmlTags, LoadContext } from '@docusaurus/types';
+export declare function shouldCreateOpenSearchFile({ context, }: {
+    context: LoadContext;
+}): boolean;
+export declare function createOpenSearchFile({ context, }: {
+    context: LoadContext;
+}): Promise<void>;
+export declare function createOpenSearchHeadTags({ context, }: {
+    context: LoadContext;
+}): HtmlTags;

package/lib/opensearch.js

@@ -0,0 +1,65 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldCreateOpenSearchFile = shouldCreateOpenSearchFile;
+exports.createOpenSearchFile = createOpenSearchFile;
+exports.createOpenSearchHeadTags = createOpenSearchHeadTags;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const eta_1 = require("eta");
+const utils_1 = require("@docusaurus/utils");
+const opensearch_1 = tslib_1.__importDefault(require("./templates/opensearch"));
+const getCompiledOpenSearchTemplate = lodash_1.default.memoize(() => (0, eta_1.compile)(opensearch_1.default.trim()));
+function renderOpenSearchTemplate(data) {
+    const compiled = getCompiledOpenSearchTemplate();
+    return compiled(data, eta_1.defaultConfig);
+}
+const OPEN_SEARCH_FILENAME = 'opensearch.xml';
+function shouldCreateOpenSearchFile({ context, }) {
+    const { siteConfig: { themeConfig, future: { experimental_router: router }, }, } = context;
+    const { algolia: { searchPagePath }, } = themeConfig;
+    return !!searchPagePath && router !== 'hash';
+}
+function createOpenSearchFileContent({ context, searchPagePath, }) {
+    const { baseUrl, siteConfig: { title, url, favicon }, } = context;
+    const siteUrl = (0, utils_1.normalizeUrl)([url, baseUrl]);
+    return renderOpenSearchTemplate({
+        title,
+        siteUrl,
+        searchUrl: (0, utils_1.normalizeUrl)([siteUrl, searchPagePath]),
+        faviconUrl: favicon ? (0, utils_1.normalizeUrl)([siteUrl, favicon]) : null,
+    });
+}
+async function createOpenSearchFile({ context, }) {
+    const { outDir, siteConfig: { themeConfig }, } = context;
+    const { algolia: { searchPagePath }, } = themeConfig;
+    if (!searchPagePath) {
+        throw new Error('no searchPagePath provided in themeConfig.algolia');
+    }
+    const fileContent = createOpenSearchFileContent({ context, searchPagePath });
+    try {
+        await fs_extra_1.default.writeFile(path_1.default.join(outDir, OPEN_SEARCH_FILENAME), fileContent);
+    }
+    catch (err) {
+        throw new Error('Generating OpenSearch file failed.', { cause: err });
+    }
+}
+function createOpenSearchHeadTags({ context, }) {
+    const { baseUrl, siteConfig: { title }, } = context;
+    return {
+        tagName: 'link',
+        attributes: {
+            rel: 'search',
+            type: 'application/opensearchdescription+xml',
+            title,
+            href: (0, utils_1.normalizeUrl)([baseUrl, OPEN_SEARCH_FILENAME]),
+        },
+    };
+}

package/lib/theme/SearchBar/index.d.ts

@@ -4,5 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference types="react" />
 export default function SearchBar(): JSX.Element;

package/lib/theme/SearchBar/index.js

@@ -73,29 +73,33 @@ function DocSearch({contextualSearch, externalUrlRegex, ...props}) {
       DocSearchModal = Modal;
     });
   }, []);
-  const onOpen = useCallback(() => {
-    importDocSearchModalIfNeeded().then(() => {
-      searchContainer.current = document.createElement('div');
-      document.body.insertBefore(
-        searchContainer.current,
-        document.body.firstChild,
-      );
-      setIsOpen(true);
-    });
-  }, [importDocSearchModalIfNeeded, setIsOpen]);
-  const onClose = useCallback(() => {
+  const prepareSearchContainer = useCallback(() => {
+    if (!searchContainer.current) {
+      const divElement = document.createElement('div');
+      searchContainer.current = divElement;
+      document.body.insertBefore(divElement, document.body.firstChild);
+    }
+  }, []);
+  const openModal = useCallback(() => {
+    prepareSearchContainer();
+    importDocSearchModalIfNeeded().then(() => setIsOpen(true));
+  }, [importDocSearchModalIfNeeded, prepareSearchContainer]);
+  const closeModal = useCallback(() => {
     setIsOpen(false);
-    searchContainer.current?.remove();
     searchButtonRef.current?.focus();
-  }, [setIsOpen]);
-  const onInput = useCallback(
+  }, []);
+  const handleInput = useCallback(
     (event) => {
-      importDocSearchModalIfNeeded().then(() => {
-        setIsOpen(true);
-        setInitialQuery(event.key);
-      });
+      if (event.key === 'f' && (event.metaKey || event.ctrlKey)) {
+        // ignore browser's ctrl+f
+        return;
+      }
+      // prevents duplicate key insertion in the modal input
+      event.preventDefault();
+      setInitialQuery(event.key);
+      openModal();
     },
-    [importDocSearchModalIfNeeded, setIsOpen, setInitialQuery],
+    [openModal],
   );
   const navigator = useRef({
     navigate({itemUrl}) {
@@ -122,8 +126,8 @@ function DocSearch({contextualSearch, externalUrlRegex, ...props}) {
     () =>
       // eslint-disable-next-line react/no-unstable-nested-components
       (footerProps) =>
-        <ResultsFooter {...footerProps} onClose={onClose} />,
-    [onClose],
+        <ResultsFooter {...footerProps} onClose={closeModal} />,
+    [closeModal],
   );
   const transformSearchClient = useCallback(
     (searchClient) => {
@@ -137,9 +141,9 @@ function DocSearch({contextualSearch, externalUrlRegex, ...props}) {
   );
   useDocSearchKeyboardEvents({
     isOpen,
-    onOpen,
-    onClose,
-    onInput,
+    onOpen: openModal,
+    onClose: closeModal,
+    onInput: handleInput,
     searchButtonRef,
   });
   return (
@@ -159,7 +163,7 @@ function DocSearch({contextualSearch, externalUrlRegex, ...props}) {
         onTouchStart={importDocSearchModalIfNeeded}
         onFocus={importDocSearchModalIfNeeded}
         onMouseOver={importDocSearchModalIfNeeded}
-        onClick={onOpen}
+        onClick={openModal}
         ref={searchButtonRef}
         translations={translations.button}
       />
@@ -169,7 +173,7 @@ function DocSearch({contextualSearch, externalUrlRegex, ...props}) {
         searchContainer.current &&
         createPortal(
           <DocSearchModal
-            onClose={onClose}
+            onClose={closeModal}
             initialScrollY={window.scrollY}
             initialQuery={initialQuery}
             navigator={navigator}

package/lib/theme/SearchPage/index.d.ts

@@ -4,5 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference types="react" />
 export default function SearchPage(): JSX.Element;

package/lib/theme/SearchPage/index.js

@@ -119,7 +119,7 @@ function SearchPageContent() {
     i18n: {currentLocale},
   } = useDocusaurusContext();
   const {
-    algolia: {appId, apiKey, indexName},
+    algolia: {appId, apiKey, indexName, contextualSearch},
   } = useAlgoliaThemeConfig();
   const processSearchResultUrl = useSearchResultUrlProcessor();
   const documentsFoundPlural = useDocumentsFoundPlural();
@@ -169,11 +169,17 @@ function SearchPageContent() {
     },
     initialSearchResultState,
   );
+  // respect settings from the theme config for facets
+  const disjunctiveFacets = contextualSearch
+    ? ['language', 'docusaurus_tag']
+    : [];
   const algoliaClient = algoliaSearch(appId, apiKey);
   const algoliaHelper = algoliaSearchHelper(algoliaClient, indexName, {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore: why errors happens after upgrading to TS 5.5 ?
     hitsPerPage: 15,
     advancedSyntax: true,
-    disjunctiveFacets: ['language', 'docusaurus_tag'],
+    disjunctiveFacets,
   });
   algoliaHelper.on(
     'result',
@@ -256,16 +262,18 @@ function SearchPageContent() {
           description: 'The search page title for empty query',
         });
   const makeSearch = useEvent((page = 0) => {
-    algoliaHelper.addDisjunctiveFacetRefinement('docusaurus_tag', 'default');
-    algoliaHelper.addDisjunctiveFacetRefinement('language', currentLocale);
-    Object.entries(docsSearchVersionsHelpers.searchVersions).forEach(
-      ([pluginId, searchVersion]) => {
-        algoliaHelper.addDisjunctiveFacetRefinement(
-          'docusaurus_tag',
-          `docs-${pluginId}-${searchVersion}`,
-        );
-      },
-    );
+    if (contextualSearch) {
+      algoliaHelper.addDisjunctiveFacetRefinement('docusaurus_tag', 'default');
+      algoliaHelper.addDisjunctiveFacetRefinement('language', currentLocale);
+      Object.entries(docsSearchVersionsHelpers.searchVersions).forEach(
+        ([pluginId, searchVersion]) => {
+          algoliaHelper.addDisjunctiveFacetRefinement(
+            'docusaurus_tag',
+            `docs-${pluginId}-${searchVersion}`,
+          );
+        },
+      );
+    }
     algoliaHelper.setQuery(searchQuery).setPage(page).search();
   });
   useEffect(() => {
@@ -335,7 +343,7 @@ function SearchPageContent() {
             />
           </div>
 
-          {docsSearchVersionsHelpers.versioningEnabled && (
+          {contextualSearch && docsSearchVersionsHelpers.versioningEnabled && (
             <SearchVersionSelectList
               docsSearchVersionsHelpers={docsSearchVersionsHelpers}
             />

package/lib/validateThemeConfig.js

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateThemeConfig = exports.Schema = exports.DEFAULT_CONFIG = void 0;
+exports.Schema = exports.DEFAULT_CONFIG = void 0;
+exports.validateThemeConfig = validateThemeConfig;
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
 exports.DEFAULT_CONFIG = {
@@ -54,4 +55,3 @@ exports.Schema = utils_validation_1.Joi.object({
 function validateThemeConfig({ validate, themeConfig, }) {
     return validate(exports.Schema, themeConfig);
 }
-exports.validateThemeConfig = validateThemeConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "3.3.2",
+  "version": "3.5.0",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": [
@@ -34,13 +34,13 @@
   },
   "dependencies": {
     "@docsearch/react": "^3.5.2",
-    "@docusaurus/core": "3.3.2",
-    "@docusaurus/logger": "3.3.2",
-    "@docusaurus/plugin-content-docs": "3.3.2",
-    "@docusaurus/theme-common": "3.3.2",
-    "@docusaurus/theme-translations": "3.3.2",
-    "@docusaurus/utils": "3.3.2",
-    "@docusaurus/utils-validation": "3.3.2",
+    "@docusaurus/core": "3.5.0",
+    "@docusaurus/logger": "3.5.0",
+    "@docusaurus/plugin-content-docs": "3.5.0",
+    "@docusaurus/theme-common": "3.5.0",
+    "@docusaurus/theme-translations": "3.5.0",
+    "@docusaurus/utils": "3.5.0",
+    "@docusaurus/utils-validation": "3.5.0",
     "algoliasearch": "^4.18.0",
     "algoliasearch-helper": "^3.13.3",
     "clsx": "^2.0.0",
@@ -51,7 +51,7 @@
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.3.2"
+    "@docusaurus/module-type-aliases": "3.5.0"
   },
   "peerDependencies": {
     "react": "^18.0.0",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "bc638d674bfbde1e254ef306697f47e764b5e107"
+  "gitHead": "cb5829f3c34b26d798b869e38ee25073488140bd"
 }

package/src/client/useAlgoliaContextualFacetFilters.ts

@@ -5,11 +5,20 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {useContextualSearchFilters} from '@docusaurus/theme-common';
+import {DEFAULT_SEARCH_TAG} from '@docusaurus/theme-common/internal';
+import {useDocsContextualSearchTags} from '@docusaurus/plugin-content-docs/client';
+import useDocusaurusContext from '@docusaurus/core/src/client/exports/useDocusaurusContext';
 
-// Translate search-engine agnostic search filters to Algolia search filters
+function useSearchTags() {
+  // only docs have custom search tags per version
+  const docsTags = useDocsContextualSearchTags();
+  return [DEFAULT_SEARCH_TAG, ...docsTags];
+}
+
+// Translate search-engine agnostic search tags to Algolia search filters
 export function useAlgoliaContextualFacetFilters(): [string, string[]] {
-  const {locale, tags} = useContextualSearchFilters();
+  const locale = useDocusaurusContext().i18n.currentLocale;
+  const tags = useSearchTags();
 
   // Seems safe to convert locale->language, see AlgoliaSearchMetadata comment
   const languageFilter = `language:${locale}`;

package/src/index.ts

@@ -5,38 +5,21 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import path from 'path';
-import fs from 'fs-extra';
-import _ from 'lodash';
-import logger from '@docusaurus/logger';
-import {defaultConfig, compile} from 'eta';
 import {normalizeUrl} from '@docusaurus/utils';
 import {readDefaultCodeTranslationMessages} from '@docusaurus/theme-translations';
-import openSearchTemplate from './templates/opensearch';
+import {
+  createOpenSearchFile,
+  createOpenSearchHeadTags,
+  shouldCreateOpenSearchFile,
+} from './opensearch';
 
 import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
 
-const getCompiledOpenSearchTemplate = _.memoize(() =>
-  compile(openSearchTemplate.trim()),
-);
-
-function renderOpenSearchTemplate(data: {
-  title: string;
-  siteUrl: string;
-  searchUrl: string;
-  faviconUrl: string | null;
-}) {
-  const compiled = getCompiledOpenSearchTemplate();
-  return compiled(data, defaultConfig);
-}
-
-const OPEN_SEARCH_FILENAME = 'opensearch.xml';
-
 export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
   const {
     baseUrl,
-    siteConfig: {title, url, favicon, themeConfig},
+    siteConfig: {themeConfig},
     i18n: {currentLocale},
   } = context;
   const {
@@ -70,45 +53,17 @@ export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
       }
     },
 
-    async postBuild({outDir}) {
-      if (searchPagePath) {
-        const siteUrl = normalizeUrl([url, baseUrl]);
-
-        try {
-          await fs.writeFile(
-            path.join(outDir, OPEN_SEARCH_FILENAME),
-            renderOpenSearchTemplate({
-              title,
-              siteUrl,
-              searchUrl: normalizeUrl([siteUrl, searchPagePath]),
-              faviconUrl: favicon ? normalizeUrl([siteUrl, favicon]) : null,
-            }),
-          );
-        } catch (err) {
-          logger.error('Generating OpenSearch file failed.');
-          throw err;
-        }
+    async postBuild() {
+      if (shouldCreateOpenSearchFile({context})) {
+        await createOpenSearchFile({context});
       }
     },
 
     injectHtmlTags() {
-      if (!searchPagePath) {
-        return {};
+      if (shouldCreateOpenSearchFile({context})) {
+        return {headTags: createOpenSearchHeadTags({context})};
       }
-
-      return {
-        headTags: [
-          {
-            tagName: 'link',
-            attributes: {
-              rel: 'search',
-              type: 'application/opensearchdescription+xml',
-              title,
-              href: normalizeUrl([baseUrl, OPEN_SEARCH_FILENAME]),
-            },
-          },
-        ],
-      };
+      return {};
     },
   };
 }

package/src/opensearch.ts

@@ -0,0 +1,115 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import path from 'path';
+import fs from 'fs-extra';
+import _ from 'lodash';
+import {defaultConfig, compile} from 'eta';
+import {normalizeUrl} from '@docusaurus/utils';
+import openSearchTemplate from './templates/opensearch';
+
+import type {HtmlTags, LoadContext} from '@docusaurus/types';
+import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
+
+const getCompiledOpenSearchTemplate = _.memoize(() =>
+  compile(openSearchTemplate.trim()),
+);
+
+function renderOpenSearchTemplate(data: {
+  title: string;
+  siteUrl: string;
+  searchUrl: string;
+  faviconUrl: string | null;
+}) {
+  const compiled = getCompiledOpenSearchTemplate();
+  return compiled(data, defaultConfig);
+}
+
+const OPEN_SEARCH_FILENAME = 'opensearch.xml';
+
+export function shouldCreateOpenSearchFile({
+  context,
+}: {
+  context: LoadContext;
+}): boolean {
+  const {
+    siteConfig: {
+      themeConfig,
+      future: {experimental_router: router},
+    },
+  } = context;
+  const {
+    algolia: {searchPagePath},
+  } = themeConfig as ThemeConfig;
+
+  return !!searchPagePath && router !== 'hash';
+}
+
+function createOpenSearchFileContent({
+  context,
+  searchPagePath,
+}: {
+  context: LoadContext;
+  searchPagePath: string;
+}): string {
+  const {
+    baseUrl,
+    siteConfig: {title, url, favicon},
+  } = context;
+
+  const siteUrl = normalizeUrl([url, baseUrl]);
+
+  return renderOpenSearchTemplate({
+    title,
+    siteUrl,
+    searchUrl: normalizeUrl([siteUrl, searchPagePath]),
+    faviconUrl: favicon ? normalizeUrl([siteUrl, favicon]) : null,
+  });
+}
+
+export async function createOpenSearchFile({
+  context,
+}: {
+  context: LoadContext;
+}): Promise<void> {
+  const {
+    outDir,
+    siteConfig: {themeConfig},
+  } = context;
+  const {
+    algolia: {searchPagePath},
+  } = themeConfig as ThemeConfig;
+  if (!searchPagePath) {
+    throw new Error('no searchPagePath provided in themeConfig.algolia');
+  }
+  const fileContent = createOpenSearchFileContent({context, searchPagePath});
+  try {
+    await fs.writeFile(path.join(outDir, OPEN_SEARCH_FILENAME), fileContent);
+  } catch (err) {
+    throw new Error('Generating OpenSearch file failed.', {cause: err});
+  }
+}
+
+export function createOpenSearchHeadTags({
+  context,
+}: {
+  context: LoadContext;
+}): HtmlTags {
+  const {
+    baseUrl,
+    siteConfig: {title},
+  } = context;
+  return {
+    tagName: 'link',
+    attributes: {
+      rel: 'search',
+      type: 'application/opensearchdescription+xml',
+      title,
+      href: normalizeUrl([baseUrl, OPEN_SEARCH_FILENAME]),
+    },
+  };
+}

package/src/theme/SearchBar/index.tsx

@@ -136,31 +136,36 @@ function DocSearch({
     });
   }, []);
 
-  const onOpen = useCallback(() => {
-    importDocSearchModalIfNeeded().then(() => {
-      searchContainer.current = document.createElement('div');
-      document.body.insertBefore(
-        searchContainer.current,
-        document.body.firstChild,
-      );
-      setIsOpen(true);
-    });
-  }, [importDocSearchModalIfNeeded, setIsOpen]);
+  const prepareSearchContainer = useCallback(() => {
+    if (!searchContainer.current) {
+      const divElement = document.createElement('div');
+      searchContainer.current = divElement;
+      document.body.insertBefore(divElement, document.body.firstChild);
+    }
+  }, []);
 
-  const onClose = useCallback(() => {
+  const openModal = useCallback(() => {
+    prepareSearchContainer();
+    importDocSearchModalIfNeeded().then(() => setIsOpen(true));
+  }, [importDocSearchModalIfNeeded, prepareSearchContainer]);
+
+  const closeModal = useCallback(() => {
     setIsOpen(false);
-    searchContainer.current?.remove();
     searchButtonRef.current?.focus();
-  }, [setIsOpen]);
+  }, []);
 
-  const onInput = useCallback(
+  const handleInput = useCallback(
     (event: KeyboardEvent) => {
-      importDocSearchModalIfNeeded().then(() => {
-        setIsOpen(true);
-        setInitialQuery(event.key);
-      });
+      if (event.key === 'f' && (event.metaKey || event.ctrlKey)) {
+        // ignore browser's ctrl+f
+        return;
+      }
+      // prevents duplicate key insertion in the modal input
+      event.preventDefault();
+      setInitialQuery(event.key);
+      openModal();
     },
-    [importDocSearchModalIfNeeded, setIsOpen, setInitialQuery],
+    [openModal],
   );
 
   const navigator = useRef({
@@ -192,8 +197,8 @@ function DocSearch({
       () =>
         // eslint-disable-next-line react/no-unstable-nested-components
         (footerProps: Omit<ResultsFooterProps, 'onClose'>): JSX.Element =>
-          <ResultsFooter {...footerProps} onClose={onClose} />,
-      [onClose],
+          <ResultsFooter {...footerProps} onClose={closeModal} />,
+      [closeModal],
     );
 
   const transformSearchClient = useCallback(
@@ -210,9 +215,9 @@ function DocSearch({
 
   useDocSearchKeyboardEvents({
     isOpen,
-    onOpen,
-    onClose,
-    onInput,
+    onOpen: openModal,
+    onClose: closeModal,
+    onInput: handleInput,
     searchButtonRef,
   });
 
@@ -233,7 +238,7 @@ function DocSearch({
         onTouchStart={importDocSearchModalIfNeeded}
         onFocus={importDocSearchModalIfNeeded}
         onMouseOver={importDocSearchModalIfNeeded}
-        onClick={onOpen}
+        onClick={openModal}
         ref={searchButtonRef}
         translations={translations.button}
       />
@@ -243,7 +248,7 @@ function DocSearch({
         searchContainer.current &&
         createPortal(
           <DocSearchModal
-            onClose={onClose}
+            onClose={closeModal}
             initialScrollY={window.scrollY}
             initialQuery={initialQuery}
             navigator={navigator}

package/src/theme/SearchPage/index.tsx

@@ -159,8 +159,9 @@ function SearchPageContent(): JSX.Element {
     i18n: {currentLocale},
   } = useDocusaurusContext();
   const {
-    algolia: {appId, apiKey, indexName},
+    algolia: {appId, apiKey, indexName, contextualSearch},
   } = useAlgoliaThemeConfig();
+
   const processSearchResultUrl = useSearchResultUrlProcessor();
   const documentsFoundPlural = useDocumentsFoundPlural();
 
@@ -213,11 +214,18 @@ function SearchPageContent(): JSX.Element {
     initialSearchResultState,
   );
 
+  // respect settings from the theme config for facets
+  const disjunctiveFacets = contextualSearch
+    ? ['language', 'docusaurus_tag']
+    : [];
+
   const algoliaClient = algoliaSearch(appId, apiKey);
   const algoliaHelper = algoliaSearchHelper(algoliaClient, indexName, {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore: why errors happens after upgrading to TS 5.5 ?
     hitsPerPage: 15,
     advancedSyntax: true,
-    disjunctiveFacets: ['language', 'docusaurus_tag'],
+    disjunctiveFacets,
   });
 
   algoliaHelper.on(
@@ -313,17 +321,19 @@ function SearchPageContent(): JSX.Element {
         });
 
   const makeSearch = useEvent((page: number = 0) => {
-    algoliaHelper.addDisjunctiveFacetRefinement('docusaurus_tag', 'default');
-    algoliaHelper.addDisjunctiveFacetRefinement('language', currentLocale);
-
-    Object.entries(docsSearchVersionsHelpers.searchVersions).forEach(
-      ([pluginId, searchVersion]) => {
-        algoliaHelper.addDisjunctiveFacetRefinement(
-          'docusaurus_tag',
-          `docs-${pluginId}-${searchVersion}`,
-        );
-      },
-    );
+    if (contextualSearch) {
+      algoliaHelper.addDisjunctiveFacetRefinement('docusaurus_tag', 'default');
+      algoliaHelper.addDisjunctiveFacetRefinement('language', currentLocale);
+
+      Object.entries(docsSearchVersionsHelpers.searchVersions).forEach(
+        ([pluginId, searchVersion]) => {
+          algoliaHelper.addDisjunctiveFacetRefinement(
+            'docusaurus_tag',
+            `docs-${pluginId}-${searchVersion}`,
+          );
+        },
+      );
+    }
 
     algoliaHelper.setQuery(searchQuery).setPage(page).search();
   });
@@ -401,7 +411,7 @@ function SearchPageContent(): JSX.Element {
             />
           </div>
 
-          {docsSearchVersionsHelpers.versioningEnabled && (
+          {contextualSearch && docsSearchVersionsHelpers.versioningEnabled && (
             <SearchVersionSelectList
               docsSearchVersionsHelpers={docsSearchVersionsHelpers}
             />