Gatsby plugin Algolia
This plugin is in beta and not officially supported yet
Feel free to open issues for any questions or ideas
You can specify a list of queries to run and how to transform them into an array of objects to index. When you run gatsby build
, it will publish those to Algolia.
Here we have an example with some data that might not be very relevant, but will work with the default configuration of gatsby new
$ yarn add gatsby-plugin-algolia
First add credentials to a .env file, which you won't commit. If you track this in your file, and especially if the site is open source, you will leak your admin API key. This would mean anyone is able to change anything on your Algolia index.
// .env.productionALGOLIA_APP_ID=XXXALGOLIA_API_KEY=XXXALGOLIA_INDEX_NAME=XXX
// gatsby-config.jsconst myQuery = `{ allSitePage { edges { node { # try to find a unique id for each node # if this field is absent, it's going to # be inserted by Algolia automatically # and will be less simple to update etc. objectID: id component path componentChunkName jsonName internal { type contentDigest owner } } } }}`; const queries = query: myQuery dataallSitePageedges // optional indexName: 'index name to target' // overrides main index name, optional settings: // optional, any index settings ; moduleexports = plugins: resolve: `gatsby-plugin-algolia` options: appId: processenvALGOLIA_APP_ID apiKey: processenvALGOLIA_API_KEY indexName: processenvALGOLIA_INDEX_NAME // for all queries queries chunkSize: 10000 // default: 1000 ;
Feedback
This is the very first version of our plugin and isn't yet officially supported. Please leave all your feedback in GitHub issues 😊