From 2c25ac60de5b3dd040fbebff7eadc426b7a20870 Mon Sep 17 00:00:00 2001 From: James Gray <101061708+randombeeper@users.noreply.github.com> Date: Mon, 27 Jan 2025 22:21:32 +0100 Subject: [PATCH] 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. --- packages/docs/docs/theme/default-theme-config.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/packages/docs/docs/theme/default-theme-config.md b/packages/docs/docs/theme/default-theme-config.md index d0d957d65f..91361f94f3 100644 --- a/packages/docs/docs/theme/default-theme-config.md +++ b/packages/docs/docs/theme/default-theme-config.md @@ -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: '', apiKey: '', - indexName: '', - // If Algolia did not provided you any `appId`, use `BH4D9OD16A` or remove this option - appId: '' + indexName: '' } } } ``` ::: 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).