Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub


A fork of gatsby-plugin-algolia-docsearch to allow configuration of DocSearch from the gatsby-config.js.


  • Node >=16
  • Gatsby 5
  • React 18


Install this package and its peer dependencies:

npm i —save gatsby-plugin-algolia-docsearch-options common-tags@1.x

Then add the following to your gatsby-config.js:

  resolve: 'gatsby-plugin-algolia-docsearch-options',
  options: {
    apiKey: process.env.API_KEY,
    indexName: 'changeme',
    inputSelector: '#docsearch-input'

It is recommended to source your API key from a “secret” location (i.e. not checked in to source control), and you should also use the read-only API key from Algolia for extra safety.

For the full list of available options, refer to the @docsearch/js documentation.

© 2023 Gatsby, Inc.