Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

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 need to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

const siteConfig = {
  ...
  algolia: {
    apiKey: 'my-api-key',
    indexName: 'my-index-name',
    algoliaOptions: {} // Optional, if provided by Algolia
  },
  ...
};

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

Controlling the Location of the Search Bar

By default, the search bar will be the rightmost element in the top navigation bar.

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

const siteConfig = {
  ...
  headerLinks: [
    {...}
    {...}
    { search: true }
    {...}
    {...}
  ],
  ...
};

Disabling the Search Bar

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

Also, if you have customized the location of the search bar in headerLinks, set search: false.