From 3ebe9cab68373c639b6e2c009d3e11f3e69f2dd9 Mon Sep 17 00:00:00 2001 From: Theodore Chu <22967798+TheodoreChu@users.noreply.github.com> Date: Wed, 6 Jan 2021 07:36:58 -0800 Subject: [PATCH] docs(v2): Add how to run your own DocSearch (#4002) --- website/docs/search.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/search.md b/website/docs/search.md index 527002cfe7..9251a7ddc3 100644 --- a/website/docs/search.md +++ b/website/docs/search.md @@ -14,6 +14,8 @@ There are two main options, you can use [Algolia DocSearch](https://docsearch.al Algolia DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (i.e., not behind a firewall). The service is free. +If your website is [not eligible](https://docsearch.algolia.com/docs/who-can-apply) for the free, hosted version of DocSearch, or if your website sits behind a firewall, then you can [run your own](https://docsearch.algolia.com/docs/run-your-own/) DocSearch crawler. For best results, you may want to use a config file based on the [Docusaurus 2 config](https://github.com/algolia/docsearch-configs/blob/master/configs/docusaurus-2.json). + ### Connecting Algolia To connect your docs with Algolia, add an `algolia` field in your `themeConfig`. **[Apply for DocSearch](https://docsearch.algolia.com/apply/)** to get your Algolia index and API key.