vitepress/docs/config/algolia-search.md

# Theme Config: Algolia Search

The `themeConfig.algolia` option allows you to use [Algolia DocSearch](https://docsearch.algolia.com). To enable it, you need to provide at least appId, apiKey and indexName:

```js
module.exports = {
  themeConfig: {
    algolia: {
      appId: 'your_app_id',
      apiKey: 'your_api_key',
      indexName: 'index_name'
    }
  }
}
```

For more options, check out [Algolia DocSearch's documentation](https://docsearch.algolia.com/docs/api/). You can pass any extra option alongside other options, e.g. passing `searchParameters`:

```js
module.exports = {
  themeConfig: {
    algolia: {
      appId: 'your_app_id',
      apiKey: 'your_api_key',
      indexName: 'index_name',
      searchParameters: {
        facetFilters: ['tags:guide,api']
      }
    }
  }
}
```

## Internationalization (i18n)

If you have multiple locales in your documentation and you have defined a `locales` object in your `themeConfig`:

```js
module.exports = {
  themeConfig: {
    locales: {
      // ...
    },
    algolia: {
      appId: 'your_app_id',
      apiKey: 'your_api_key',
      indexName: 'index_name'
    }
  }
}
```

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.
docs: add algolia search config 4 years ago			`# Theme Config: Algolia Search`

docs: algolia appId is required (#608) 3 years ago			The `themeConfig.algolia` option allows you to use [Algolia DocSearch](https://docsearch.algolia.com). To enable it, you need to provide at least appId, apiKey and indexName:
docs: add algolia search config 4 years ago
			```js
			`module.exports = {`
style: format code with prettier 4 years ago			`themeConfig: {`
docs: add algolia search config 4 years ago			`algolia: {`
docs: algolia appId is required (#608) 3 years ago			`appId: 'your_app_id',`
docs: add algolia search config 4 years ago			`apiKey: 'your_api_key',`
			`indexName: 'index_name'`
			`}`
			`}`
			`}`
			```

docs: update links (#523) * docs: update links * docs: fix 3xx urls * chore: fix typo 3 years ago			For more options, check out [Algolia DocSearch's documentation](https://docsearch.algolia.com/docs/api/). You can pass any extra option alongside other options, e.g. passing `searchParameters`:
fix(locales): use correct lang (#283) 4 years ago
			```js
			`module.exports = {`
			`themeConfig: {`
			`algolia: {`
docs: algolia appId is required (#608) 3 years ago			`appId: 'your_app_id',`
fix(locales): use correct lang (#283) 4 years ago			`apiKey: 'your_api_key',`
			`indexName: 'index_name',`
			`searchParameters: {`
			`facetFilters: ['tags:guide,api']`
			`}`
			`}`
			`}`
			`}`
			```

			`## Internationalization (i18n)`

			If you have multiple locales in your documentation and you have defined a `locales` object in your `themeConfig`:

			```js
			`module.exports = {`
			`themeConfig: {`
			`locales: {`
			`// ...`
			`},`
			`algolia: {`
docs: algolia appId is required (#608) 3 years ago			`appId: 'your_app_id',`
fix(locales): use correct lang (#283) 4 years ago			`apiKey: 'your_api_key',`
			`indexName: 'index_name'`
			`}`
			`}`
			`}`
			```

fix: use algolia search lang (#459) 3 years ago			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.