Algolia DocSearch

How to use Algolia DocSearch

You can use Algolia DocSearch to add a search feature to your documentation website. The following steps outline how to set it up:

1. First, create an Algolia account if you don't already have one.

2. Next, in the Algolia dashboard, click on the "DocSearch" tab and then click on the "Get started" button. Fill out the form that appears with information about your documentation website, including its URL and the name of the documentation.

3. After submitting the form, Algolia will generate a configuration file for your website. Download this file and save it in your website's root directory.

4. In your website's HTML code, add the Algolia DocSearch widget script tag just before the closing body tag:

   <script async src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
   

5. Finally, initialize the Algolia DocSearch widget by calling the

   docsearch()
   function with your configuration file as an argument. This should be done just before the closing body tag as well:

   <script>
     docsearch({
       apiKey: 'YOUR_API_KEY',
       indexName: 'YOUR_INDEX_NAME',
       inputSelector: '#YOUR_SEARCH_BOX_SELECTOR',
       // ...other options
     });
   </script>
   

   Replace

   YOUR_API_KEY
   and
   YOUR_INDEX_NAME
   with the values provided in your configuration file. Also, replace
   YOUR_SEARCH_BOX_SELECTOR
   with the CSS selector for the search box on your documentation website.

And that's it! Once you've added these code snippets to your website, you'll have an Algolia DocSearch widget up and running, allowing visitors to easily search your documentation.