@easyops-cn/docusaurus-search-local 0.33.1 → 0.33.3

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.33.3](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.33.2...v0.33.3) (2022-10-18)
+
+
+### Bug Fixes
+
+* pass version instead of detect version in search page ([8ca32f0](https://github.com/easyops-cn/docusaurus-search-local/commit/8ca32f07ca4d36e061dd67f72a0fc1b477d2c9f6)), closes [#285](https://github.com/easyops-cn/docusaurus-search-local/issues/285)
+
+## [0.33.2](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.33.1...v0.33.2) (2022-10-17)
+
+
+### Bug Fixes
+
+* fix search terms highlighting ([aacc610](https://github.com/easyops-cn/docusaurus-search-local/commit/aacc610db70f60585d883f977ae2da699dde6f29)), closes [#266](https://github.com/easyops-cn/docusaurus-search-local/issues/266)
+
 ## [0.33.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.33.0...v0.33.1) (2022-10-17)
 
 

package/dist/client/client/theme/SearchBar/SearchBar.jsx

@@ -131,9 +131,18 @@ export default function SearchBar({ handleSearchBarToggle, }) {
                             return;
                         }
                         const a = document.createElement("a");
-                        const url = `${baseUrl}search?q=${encodeURIComponent(query)}${Array.isArray(searchContextByPaths)
-                            ? `&ctx=${encodeURIComponent(searchContext)}`
-                            : ""}`;
+                        const params = new URLSearchParams();
+                        params.set("q", encodeURIComponent(query));
+                        if (Array.isArray(searchContextByPaths)) {
+                            params.set("ctx", searchContext);
+                        }
+                        if (versionUrl !== baseUrl) {
+                            if (!versionUrl.startsWith(baseUrl)) {
+                                throw new Error(`Version url '${versionUrl}' does not start with base url '${baseUrl}', this is a bug of \`@easyops-cn/docusaurus-search-local\`, please report it.`);
+                            }
+                            params.set("version", versionUrl.substring(baseUrl.length));
+                        }
+                        const url = `${baseUrl}search?${params.toString()}`;
                         a.href = url;
                         a.textContent = translate({
                             id: "theme.SearchBar.seeAll",

package/dist/client/client/theme/SearchPage/SearchPage.jsx

@@ -4,8 +4,7 @@ import Layout from "@theme/Layout";
 import Head from "@docusaurus/Head";
 import Link from "@docusaurus/Link";
 import { translate } from "@docusaurus/Translate";
-import { usePluralForm, useDocsPreferredVersion, ReactContextError, } from "@docusaurus/theme-common";
-import { useActivePlugin } from "@docusaurus/plugin-content-docs/client";
+import { usePluralForm } from "@docusaurus/theme-common";
 import useSearchQuery from "../hooks/useSearchQuery";
 import { fetchIndexes } from "../SearchBar/fetchIndexes";
 import { SearchSourceFactory } from "../../utils/SearchSourceFactory";
@@ -14,7 +13,7 @@ import { highlightStemmed } from "../../utils/highlightStemmed";
 import { getStemmedPositions } from "../../utils/getStemmedPositions";
 import LoadingRing from "../LoadingRing/LoadingRing";
 import { concatDocumentPath } from "../../utils/concatDocumentPath";
-import { docsPluginIdForPreferredVersion, indexDocs, } from "../../utils/proxiedGenerated";
+import { Mark } from "../../utils/proxiedGenerated";
 import styles from "./SearchPage.module.css";
 export default function SearchPage() {
     return (<Layout>
@@ -23,35 +22,12 @@ export default function SearchPage() {
 }
 function SearchPageContent() {
     const { siteConfig: { baseUrl }, } = useDocusaurusContext();
-    // It returns undefined for non-docs pages.
-    const activePlugin = useActivePlugin();
-    let versionUrl = baseUrl;
-    // There is an issue, see `SearchBar.tsx`.
-    try {
-        // The try-catch is a hack because useDocsPreferredVersion just throws an
-        // exception when versions are not used.
-        // The same hack is used in SearchBar.tsx
-        // eslint-disable-next-line react-hooks/rules-of-hooks
-        const { preferredVersion } = useDocsPreferredVersion(activePlugin?.pluginId ?? docsPluginIdForPreferredVersion);
-        if (preferredVersion && !preferredVersion.isLast) {
-            versionUrl = preferredVersion.path + "/";
-        }
-    }
-    catch (e) {
-        if (indexDocs) {
-            if (e instanceof ReactContextError) {
-                /* ignore, happens when website doesn't use versions */
-            }
-            else {
-                throw e;
-            }
-        }
-    }
     const { selectMessage } = usePluralForm();
-    const { searchValue, searchContext, updateSearchPath } = useSearchQuery();
+    const { searchValue, searchContext, searchVersion, updateSearchPath } = useSearchQuery();
     const [searchQuery, setSearchQuery] = useState(searchValue);
     const [searchSource, setSearchSource] = useState();
     const [searchResults, setSearchResults] = useState();
+    const versionUrl = `${baseUrl}${searchVersion}`;
     const pageTitle = useMemo(() => searchQuery
         ? translate({
             id: "theme.SearchPage.existingResultsTitle",
@@ -147,9 +123,17 @@ function SearchResultItem({ searchResult: { document, type, page, tokens, metada
     if (!isTitle) {
         pathItems.push(page.t);
     }
+    let search = "";
+    if (Mark && tokens.length > 0) {
+        const params = new URLSearchParams();
+        for (const token of tokens) {
+            params.append("_highlight", token);
+        }
+        search = `?${params.toString()}`;
+    }
     return (<article className={styles.searchResultItem}>
       <h2>
-        <Link to={document.u + (document.h || "")} dangerouslySetInnerHTML={{
+        <Link to={document.u + search + (document.h || "")} dangerouslySetInnerHTML={{
             __html: isContent
                 ? highlight(articleTitle, tokens)
                 : highlightStemmed(articleTitle, getStemmedPositions(metadata, "t"), tokens, 100),

package/dist/client/client/theme/hooks/useSearchQuery.js

@@ -7,9 +7,9 @@
 import { useHistory, useLocation } from "@docusaurus/router";
 import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
-import { searchContextByPaths, } from "../../utils/proxiedGenerated";
 const SEARCH_PARAM_QUERY = "q";
 const SEARCH_PARAM_CONTEXT = "ctx";
+const SEARCH_PARAM_VERSION = "version";
 function useSearchQuery() {
     const history = useHistory();
     const location = useLocation();
@@ -17,26 +17,31 @@ function useSearchQuery() {
     const params = ExecutionEnvironment.canUseDOM ? new URLSearchParams(location.search) : null;
     const searchValue = params?.get(SEARCH_PARAM_QUERY) || "";
     const searchContext = params?.get(SEARCH_PARAM_CONTEXT) || "";
+    const searchVersion = params?.get(SEARCH_PARAM_VERSION) || "";
+    const getSearchParams = (searchValue) => {
+        const searchParams = new URLSearchParams(location.search);
+        if (searchValue) {
+            searchParams.set(SEARCH_PARAM_QUERY, searchValue);
+        }
+        else {
+            searchParams.delete(SEARCH_PARAM_QUERY);
+        }
+        return searchParams;
+    };
     return {
         searchValue,
         searchContext,
+        searchVersion,
         updateSearchPath: (searchValue) => {
-            const searchParams = new URLSearchParams(location.search);
-            if (searchValue) {
-                searchParams.set(SEARCH_PARAM_QUERY, searchValue);
-            }
-            else {
-                searchParams.delete(SEARCH_PARAM_QUERY);
-            }
+            const searchParams = getSearchParams(searchValue);
             history.replace({
                 search: searchParams.toString(),
             });
         },
         generateSearchPageLink: (searchValue) => {
-            const searchParams = new URLSearchParams(location.search);
-            const searchContext = searchParams.get(SEARCH_PARAM_CONTEXT) || "";
+            const searchParams = getSearchParams(searchValue);
             // Refer to https://github.com/facebook/docusaurus/pull/2838
-            return `${baseUrl}search?q=${encodeURIComponent(searchValue)}${Array.isArray(searchContextByPaths) ? `&ctx=${encodeURIComponent(searchContext)}` : ""}`;
+            return `${baseUrl}search?${searchParams.toString()}`;
         },
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.33.1",
+  "version": "0.33.3",
   "description": "An offline/local search plugin for Docusaurus v2",
   "repository": "https://github.com/easyops-cn/docusaurus-search-local",
   "homepage": "https://github.com/easyops-cn/docusaurus-search-local",