Content Search
About 213 wordsLess than 1 minute
2025-10-09
Local Search
Overview
Adds local search functionality to the site.
Related plugin: @vuepress-plume/plugin-search
This plugin uses minisearch for content search.
Default configuration:
.vuepress/config.ts
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
search: {
provider: 'local',
// more options...
},
// Can also be configured via plugins.search, but not recommended
plugins: {
search: {},
}
})
})
Configuration
interface SearchOptions {
/**
* Local search internationalization
*/
locales?: {
[locale: string]: SearchBoxLocale
}
/**
* Whether articles are searchable, defaults to `() => true`
*/
isSearchable?: (page: Page) => boolean
}
interface SearchBoxLocale {
placeholder: string
buttonText: string
resetButtonTitle: string
backButtonTitle: string
noResultsText: string
footer: {
selectText: string
selectKeyAriaLabel: string
navigateText: string
navigateUpKeyAriaLabel: string
navigateDownKeyAriaLabel: string
closeText: string
closeKeyAriaLabel: string
}
}
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
.vuepress/config.ts
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
},
// Can also be configured via plugins.docsearch, but not recommended
plugins: {
docsearch: {},
}
})
})
Contributors
Changelog
10/9/25, 7:46 AM
View All Changelog
38505
-docs: update en docs (#708)on4d236
-feat(theme)!: add collections support (#704)on74dfa
-docs: enable twoslash for code blockon0fd6c
-refactor(theme): improve types and flat config (#524)on0c53b
-docs: improve docs (#332)onb079a
-docs: update docson2fb3d
-docs: update theme docsonca097
-docs: lint fixonc56ba
-feat: 全新的文档!on