Content Search
Local Search
Overview
Adds local search functionality to the site.
For feature details, please refer to Search Feature
Related plugin: @vuepress-plume/plugin-search
Default configuration:
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
search: {
provider: 'local',
// more options...
},
})
})For configuration entry priority information, please refer to Plugin Configuration Entry.
Configuration
interface SearchOptions {
/**
* Search provider, fixed to 'local' for local search (required)
*/
provider: 'local'
/**
* Local search internationalization
*/
locales?: {
[locale: string]: SearchBoxLocale
}
/**
* Whether articles are searchable, defaults to `() => true`
*
* Note: encrypted pages (matched by `encrypt.rules` or having a page `password`)
* are never indexed, because the search index is shipped as a public static asset
* and indexing them would leak their content.
*/
isSearchable?: (page: Page) => boolean
/**
* Whether to disable search query persistence in session storage
*
* @default false
*/
disableQueryPersistence?: boolean
/**
* MiniSearch configuration
*/
miniSearch?: {
/**
* MiniSearch instance options
* @see https://lucaong.github.io/minisearch/modules/_minisearch_.html#options
*/
options?: Pick<MiniSearchOptions, 'extractField' | 'tokenize' | 'processTerm'>
/**
* MiniSearch search options
* @see https://lucaong.github.io/minisearch/modules/_minisearch_.html#searchoptions-1
*/
searchOptions?: MiniSearchOptions['searchOptions']
}
}
interface SearchBoxLocale {
placeholder: string
buttonText: string
resetButtonTitle: string
backButtonTitle: string
noResultsText: string
/**
* Text shown when the search index is missing or fails to load
*/
searchIndexErrorText?: string
/**
* Fallback text shown when JavaScript is disabled
*
* It is rendered inside `<noscript>`, so it must be plain text without
* HTML-escaped characters
*/
noscriptText?: string
footer: {
selectText: string
selectKeyAriaLabel: string
navigateText: string
navigateUpKeyAriaLabel: string
navigateDownKeyAriaLabel: string
closeText: string
closeKeyAriaLabel: string
}
}Disabling
Setting search to false completely disables search, and the navbar will no longer render the search box:
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
search: false,
}),
})Algolia DocSearch
Overview
A site content search plugin powered by Algolia DocSearch
Related plugin: @vuepress/plugin-docsearch
Refer to Algolia DocSearch Reference for more information.
Enable
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
search: {
provider: 'algolia',
appId: 'YOUR_APP_ID',
apiKey: 'YOUR_API_KEY',
indexName: 'YOUR_INDEX_NAME', // more options
},
})
})For configuration entry priority information, please refer to Plugin Configuration Entry.
