Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update default-theme-config.md #3232

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −5
Open

Update default-theme-config.md #3232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions packages/docs/docs/theme/default-theme-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,24 +399,23 @@ If you need full text search, you can use [Algolia Search](#algolia-search).

### Algolia Search

The `themeConfig.algolia` option allows you to use [Algolia DocSearch](https://docsearch.algolia.com/) to replace the simple built-in search. 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 replace the simple built-in search. To enable it, you need to provide `apiKey`, `indexName`, and `appId`:

``` js
// .vuepress/config.js
module.exports = {
themeConfig: {
algolia: {
appId: '<APP_ID>',
apiKey: '<API_KEY>',
indexName: '<INDEX_NAME>',
// If Algolia did not provided you any `appId`, use `BH4D9OD16A` or remove this option
appId: '<APP_ID>'
indexName: '<INDEX_NAME>'
}
}
}
```

::: warning Note
Unlike the [built-in search](#built-in-search) engine which works out of the box, [Algolia DocSearch](https://docsearch.algolia.com/) requires you to submit your site to them for indexing before it starts working.
Unlike the [built-in search](#built-in-search) engine which works out of the box, [Algolia DocSearch](https://docsearch.algolia.com/) requires you to submit your site to them for indexing before it starts working. After submitting the form, upon approval you will get the credentials to be entered above.
:::

For more options, check out [Algolia DocSearch’s documentation](https://github.com/algolia/docsearch#docsearch-options).
Expand Down