Skip to content

Commit 77efd93

Browse files
authored
docs: algolia appId is required (#608)
1 parent c1d964c commit 77efd93

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

docs/config/algolia-search.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Theme Config: Algolia Search
22

3-
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:
3+
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:
44

55
```js
66
module.exports = {
77
themeConfig: {
88
algolia: {
9+
appId: 'your_app_id',
910
apiKey: 'your_api_key',
1011
indexName: 'index_name'
1112
}
@@ -19,6 +20,7 @@ For more options, check out [Algolia DocSearch's documentation](https://docsearc
1920
module.exports = {
2021
themeConfig: {
2122
algolia: {
23+
appId: 'your_app_id',
2224
apiKey: 'your_api_key',
2325
indexName: 'index_name',
2426
searchParameters: {
@@ -40,6 +42,7 @@ module.exports = {
4042
// ...
4143
},
4244
algolia: {
45+
appId: 'your_app_id',
4346
apiKey: 'your_api_key',
4447
indexName: 'index_name'
4548
}

types/default-theme.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ export namespace DefaultTheme {
121121
// algolia ------------------------------------------------------------------
122122
// partially copied from @docsearch/react/dist/esm/DocSearch.d.ts
123123
export interface AlgoliaSearchOptions {
124-
appId?: string
124+
appId: string
125125
apiKey: string
126126
indexName: string
127127
placeholder?: string

0 commit comments

Comments
 (0)