Merge pull request #383 from easyops-cn/steve/custom-search-context-l…

…abels feat(): customize search context labels
easyops-cn · Dec 15, 2023 · 5fe4374 · 5fe4374
2 parents e29f21f + 33787d5
commit 5fe4374
Show file tree

Hide file tree

Showing 8 changed files with 76 additions and 43 deletions.
diff --git a/README.md b/README.md
diff --git a/docusaurus-search-local/src/client/theme/SearchBar/SearchBar.tsx b/docusaurus-search-local/src/client/theme/SearchBar/SearchBar.tsx
@@ -112,9 +112,14 @@ export default function SearchBar({
     let nextSearchContext = "";
     if (location.pathname.startsWith(versionUrl)) {
       const uri = location.pathname.substring(versionUrl.length);
-      const matchedPath = searchContextByPaths.find(
-        (path) => uri === path || uri.startsWith(`${path}/`)
-      );
+      let matchedPath: string | undefined;
+      for (const _path of searchContextByPaths) {
+        const path = typeof _path === "string" ? _path : _path.path;
+        if (uri === path || uri.startsWith(`${path}/`)) {
+          matchedPath = path;
+          break;
+        }
+      }
       if (matchedPath) {
         nextSearchContext = matchedPath;
       }

diff --git a/docusaurus-search-local/src/client/theme/SearchPage/SearchPage.tsx b/docusaurus-search-local/src/client/theme/SearchPage/SearchPage.tsx
@@ -174,11 +174,20 @@ function SearchPageContent(): React.ReactElement {
                       })
                     : ""}
                 </option>
-                {searchContextByPaths.map((context: string) => (
-                  <option key={context} value={context}>
-                    {context}
-                  </option>
-                ))}
+                {searchContextByPaths.map((context) => {
+                  let label: string;
+                  let path: string;
+                  if (typeof context === "string") {
+                    label = path = context;
+                  } else {
+                    ({ label, path } = context);
+                  }
+                  return (
+                    <option key={path} value={path}>
+                      {label}
+                    </option>
+                  );
+                })}
               </select>
             </div>
           ) : null}

diff --git a/docusaurus-search-local/src/declarations.ts b/docusaurus-search-local/src/declarations.ts
@@ -20,7 +20,10 @@ declare module "*/generated.js" {
   export const searchBarPosition: "left" | "right";
   export const docsPluginIdForPreferredVersion: string;
   export const indexDocs: boolean;
-  export const searchContextByPaths: string[];
+  export const searchContextByPaths: (
+    | string
+    | { label: string; path: string }
+  )[];
   export const hideSearchBarWithNoSearchContext: boolean;
   export const useAllContextsWithNoSearchContext: boolean;
   // These below are for mocking only.

diff --git a/docusaurus-search-local/src/index.ts b/docusaurus-search-local/src/index.ts
@@ -167,7 +167,7 @@ export interface PluginOptions {
    * Provide an list of sub-paths as separate search context, E.g.: `["docs", "community", "legacy/resources"]`.
    * It will create multiple search indexes by these paths.
    */
-  searchContextByPaths?: string[];
+  searchContextByPaths?: (string | { label: string; path: string })[];
 
   /**
    * Whether to hide the search bar when no search context was matched.

diff --git a/docusaurus-search-local/src/server/utils/postBuildFactory.ts b/docusaurus-search-local/src/server/utils/postBuildFactory.ts
@@ -48,9 +48,14 @@ export function postBuildFactory(
           for (const doc of documents) {
             if (doc.u.startsWith(baseUrl)) {
               const uri = doc.u.substring(baseUrl.length);
-              const matchedPath = searchContextByPaths.find(
-                (path) => uri === path || uri.startsWith(`${path}/`)
-              );
+              let matchedPath: string | undefined;
+              for (const _path of searchContextByPaths) {
+                const path = typeof _path === "string" ? _path : _path.path;
+                if (uri === path || uri.startsWith(`${path}/`)) {
+                  matchedPath = path;
+                  break;
+                }
+              }
               if (matchedPath) {
                 let dirAllDocs = docsByDirMap.get(matchedPath);
                 if (!dirAllDocs) {

diff --git a/docusaurus-search-local/src/server/utils/validateOptions.ts b/docusaurus-search-local/src/server/utils/validateOptions.ts
@@ -43,7 +43,15 @@ const schema = Joi.object<PluginOptions>({
   docsPluginIdForPreferredVersion: Joi.string(),
   zhUserDict: Joi.string(),
   zhUserDictPath: Joi.string(),
-  searchContextByPaths: Joi.array().items(Joi.string()),
+  searchContextByPaths: Joi.array().items(
+    Joi.alternatives().try(
+      Joi.string(),
+      Joi.object<{ label: string; path: string }>({
+        label: Joi.string(),
+        path: Joi.string(),
+      })
+    )
+  ),
   hideSearchBarWithNoSearchContext: Joi.boolean().default(false),
   useAllContextsWithNoSearchContext: Joi.boolean().default(false),
 });

diff --git a/website-multi-docs/docusaurus.config.js b/website-multi-docs/docusaurus.config.js
@@ -156,7 +156,10 @@ const config = {
         docsRouteBasePath: ["docs", "community"],
         docsDir: ["docs", "community"],
         docsPluginIdForPreferredVersion: "product",
-        searchContextByPaths: ["docs", "community"],
+        searchContextByPaths: [
+          "docs",
+          { label: "Community", path: "community" },
+        ],
         hideSearchBarWithNoSearchContext: true,
       }),
     ],