3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-01 18:32:52 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: Algolia plugin must be enabled before crawling the site (#5658)

Browse source
This commit is contained in:
Sébastien Lorber 2021-10-07 17:00:47 +02:00 • committed by GitHub
parent eaacb0e98a
commit 7b64e85dc3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
website/docs/search.md
View file

@ -105,6 +105,14 @@ The `searchParameters` option used to be named `algoliaOptions` in Docusaurus v1
:::
:::caution
The search feature will not work reliably until Algolia crawls your site with the **search plugin enabled**.
If you are installing the Algolia plugin for the first time and want to ensure the search feature works before deploying it to production, you can ask the DocSearch team to trigger a crawl on a staging environment url or deploy preview.
:::
### Contextual search {#contextual-search}
Contextual search is mostly useful for versioned Docusaurus sites.