Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Update default-theme-config.md #3232

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
Loading
from
Open
Changes from all commits
Commits
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
Update default-theme-config.md
I manage the DocSearch program at Algolia. I updated these instructions to be a little more clear. DocSearch now requires all three pieces of information, which is provided to the user upon approval. The appId BH4D9OD16A is no longer used in new applications.
  • Loading branch information
randombeeper authored Jan 27, 2025
commit 2c25ac60de5b3dd040fbebff7eadc426b7a20870
9 changes: 4 additions & 5 deletions 9 packages/docs/docs/theme/default-theme-config.md
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
Morty Proxy This is a proxified and sanitized view of the page, visit original site.