msb-public
/
vitepress
mirror of https://github.com/vuejs/vitepress
2
1
Code Issues Projects Releases Wiki Activity

fix: use algolia search lang (#459)

Browse Source
pull/486/head
Eduardo San Martin Morote 3 years ago committed by GitHub
parent a8f147f153
commit 444562c3a7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 41 deletions
Show Stats Download Patch File Download Diff File

39
docs/config/algolia-search.md
Unescape View File

@ -47,41 +47,4 @@ module.exports = {
} }
``` ```
VitePress will automatically add a `language` _facetFilter_ to the `searchParameters.facetFilter` array with the correct language value. **Make sure to properly configure your DocSearch config as well** by adding `language` as a _custom attribute for faceting_ and by setting it based on the `lang` attribute of the `<html>` element. Here is a short example of DocSearch config: VitePress will automatically add a `lang` _facetFilter_ to the `searchParameters.facetFilter` array with the correct language value. Algolia automatically adds the correct facet filter based on the `lang` attribute on the `<html>` tag. This will match search results with the currently viewed language of the page.
```json
{
"index_name": "<the name of your library>",
"start_urls": [
{
"url": "<your deployed url>"
}
],
"stop_urls": ["(?:(?<!\\.html)(?<!/))$"],
"selectors": {
"lvl0": {
"selector": ".sidebar > .sidebar-links > .sidebar-link .sidebar-link-item.active",
"global": true,
"default_value": "Documentation"
},
"lvl1": ".content h1",
"lvl2": ".content h2",
"lvl3": ".content h3",
"lvl4": ".content h4",
"lvl5": ".content h5",
"lvl6": ".content p, .content li",
"text": ".content [class^=language-]",
"language": {
"selector": "/html/@lang",
"type": "xpath",
"global": true,
"default_value": "en-US"
}
},
"custom_settings": {
"attributesForFaceting": ["language"]
}
}
```
You can take a look at the [DocSearch config used by Vue Router](https://github.com/algolia/docsearch-configs/blob/master/configs/next_router_vuejs.json) for a complete example.

6
src/client/theme-default/components/AlgoliaSearchBox.vue
Unescape View File

@ -55,7 +55,7 @@ const { lang } = useData()
// if the user has multiple locales, the search results should be filtered // if the user has multiple locales, the search results should be filtered
// based on the language // based on the language
const facetFilters: string[] = props.multilang const facetFilters: string[] = props.multilang
? ['language:' + lang.value] ? ['lang:' + lang.value]
: [] : []
if (props.options.searchParameters?.facetFilters) { if (props.options.searchParameters?.facetFilters) {
@ -66,10 +66,10 @@ watch(
lang, lang,
(newLang, oldLang) => { (newLang, oldLang) => {
const index = facetFilters.findIndex( const index = facetFilters.findIndex(
(filter) => filter === 'language:' + oldLang (filter) => filter === 'lang:' + oldLang
) )
if (index > -1) { if (index > -1) {
facetFilters.splice(index, 1, 'language:' + newLang) facetFilters.splice(index, 1, 'lang:' + newLang)
} }
} }
) )

Write Preview
Loading…
Cancel
Save