feat(plugin-docsearch): support indexBase option (close #1223) (#1224)

Co-authored-by: meteorlxy <[email protected]>

Author: Mister-Hope

docs/reference/plugin/docsearch.md

@@ -316,6 +316,20 @@ export default {
 - Also see:
   - [Guide > I18n](../../guide/i18n.md)
 
+### indexBase
+
+- Type: `string`
+
+- Default: [base](../config.md#base)
+
+- Details:
+
+  The base path of the search index.
+
+  If you are deploying your site to multiple domains, you don't need to submit all of them to DocSearch and generate search index separately. You could choose one of the domains as the _index domain_, and only submit the _index domain_ to Docsearch for crawling search index. Then, you could reuse the search index across all deployments.
+  
+  However, if the [base](../config.md#base) of your deployments are different for different domains, you need to set the option to the [base](../config.md#base) of your _index domain_, so that other deployments could reuse the search index correctly.
+
 ### injectStyles
 
 - Type: `boolean`
@@ -327,7 +341,7 @@ export default {
   Whether to inject the default styles of DocSearch or not.
 
   If you think the default styles of DocSearch is not compatible with your site, you can try to override the default styles, or set this option to `false` to totally exclude the default styles.
-  
+
   When this option is disabled, you need to import your own styles for DocSearch. Also notice that all styles customization in [Styles](#styles) section would be unavailable.
 
 ## Styles

docs/zh/reference/plugin/docsearch.md

@@ -315,6 +315,20 @@ export default {
 - 参考：
   - [指南 > 多语言支持](../../guide/i18n.md)
 
+### indexBase
+
+- 类型： `string`
+
+- 默认值： [base](../config.md#base)
+
+- 详情：
+
+  搜索索引基础路径。
+
+  如果你需要把你的站点部署到不同的域名上，你不需要把它们全都提交到 Docsearch 上来分别生成搜索索引。你可以选择其中一个域名作为 _索引域名_ ，并且仅将 _索引域名_ 提交到 DocSearch 上来爬去搜索索引。然后，你就可以在不同的部署域名下复用索引。
+
+  如果你不同部署域名下的 [base](../config.md#base) 是不一样的，你就需要将这个配置设置成 _索引域名_ 的 [base](../config.md#base) ，这样其他的部署域名就可以正确复用索引了。
+
 ### injectStyles
 
 - 类型： `boolean`

ecosystem/plugin-docsearch/src/client/composables/useDocsearchShim.ts

@@ -3,6 +3,8 @@ import { resolveRoutePathFromUrl } from '@vuepress/shared'
 import { debounce } from 'ts-debounce'
 import { useRouter } from 'vue-router'
 
+declare const __DOCSEARCH_INDEX_BASE__: string
+
 const isSpecialClick = (event: MouseEvent): boolean =>
   event.button === 1 ||
   event.altKey ||
@@ -32,7 +34,9 @@ export const useDocsearchShim = (): Partial<DocSearchProps> => {
               return
             }
             event.preventDefault()
-            router.push(resolveRoutePathFromUrl(hit.url, __VUEPRESS_BASE__))
+            router.push(
+              resolveRoutePathFromUrl(hit.url, __DOCSEARCH_INDEX_BASE__)
+            )
           },
           children,
         },
@@ -43,7 +47,7 @@ export const useDocsearchShim = (): Partial<DocSearchProps> => {
     navigator: {
       // when pressing Enter without metaKey
       navigate: ({ itemUrl }) => {
-        router.push(resolveRoutePathFromUrl(itemUrl, __VUEPRESS_BASE__))
+        router.push(resolveRoutePathFromUrl(itemUrl, __DOCSEARCH_INDEX_BASE__))
       },
     },
 

ecosystem/plugin-docsearch/src/node/docsearchPlugin.ts

@@ -4,20 +4,33 @@ import type { DocsearchOptions } from '../shared/index.js'
 
 const __dirname = getDirname(import.meta.url)
 
+/**
+ * Options for @vuepress/plugin-docsearch
+ */
 export interface DocsearchPluginOptions extends DocsearchOptions {
+  /**
+   * Base path of the search index
+   */
+  indexBase?: string
+
+  /**
+   * Whether to inject docsearch default styles
+   */
   injectStyles?: boolean
 }
 
 export const docsearchPlugin = ({
   injectStyles = true,
+  indexBase,
   ...options
 }: DocsearchPluginOptions): Plugin => ({
   name: '@vuepress/plugin-docsearch',
 
   clientConfigFile: path.resolve(__dirname, '../client/config.js'),
 
-  define: {
-    __DOCSEARCH_OPTIONS__: options,
+  define: (app) => ({
     __DOCSEARCH_INJECT_STYLES__: injectStyles,
-  },
+    __DOCSEARCH_INDEX_BASE__: indexBase || app.options.base,
+    __DOCSEARCH_OPTIONS__: options,
+  }),
 })