diff --git a/docs/config/algolia-search.md b/docs/config/algolia-search.md index 28e4e5fd..132b0a56 100644 --- a/docs/config/algolia-search.md +++ b/docs/config/algolia-search.md @@ -1,11 +1,12 @@ # 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 apiKey and indexName: +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' } @@ -19,6 +20,7 @@ For more options, check out [Algolia DocSearch's documentation](https://docsearc module.exports = { themeConfig: { algolia: { + appId: 'your_app_id', apiKey: 'your_api_key', indexName: 'index_name', searchParameters: { @@ -40,6 +42,7 @@ module.exports = { // ... }, algolia: { + appId: 'your_app_id', apiKey: 'your_api_key', indexName: 'index_name' } diff --git a/types/default-theme.d.ts b/types/default-theme.d.ts index d7284871..60a45fa7 100644 --- a/types/default-theme.d.ts +++ b/types/default-theme.d.ts @@ -121,7 +121,7 @@ export namespace DefaultTheme { // algolia ------------------------------------------------------------------ // partially copied from @docsearch/react/dist/esm/DocSearch.d.ts export interface AlgoliaSearchOptions { - appId?: string + appId: string apiKey: string indexName: string placeholder?: string