Gatsby Config API

The gatsby-config defines your site’s metadata, plugins, and other general configuration. This file should be in the root of your Gatsby site. You can author the file in JavaScript (CommonJS or ES Modules (ESM) syntax) or TypeScript, for example gatsby-config.js, gatsby-config.mjs, or gatsby-config.ts.

If you created a Gatsby site with the npm init gatsby command, there should already be a sample configuration file in your site’s directory. Note: There are many sample configs which may be helpful to reference in the different Gatsby example websites.

Set up the configuration file

The configuration file should export a JavaScript object. Within this object, you can define several different configuration options.

An example gatsby-config.js file could look like this:

The TypeScript and Gatsby documentation shows how to set up a configuration file in TypeScript.

Read the ES Modules (ESM) and Gatsby documentation if you don’t want to use CommonJS syntax.

Configuration options

Options available to set within gatsby-config include:

1. siteMetadata (object)
2. plugins (array)
3. flags (object)
4. pathPrefix (string)
5. trailingSlash (string)
6. graphqlTypegen (boolean)
7. adapter (object)
8. headers (array)
9. polyfill (boolean)
10. mapping (object)
11. proxy (object)
12. developMiddleware (function)
13. jsxRuntime (string)
14. jsxImportSource (string)

siteMetadata

When you want to reuse common pieces of data across the site (for example, your site title), you can store that data in siteMetadata:

This way you can store it in one place, and pull it whenever you need it. If you ever need to update the info, you only have to change it here.

See a full description and sample usage in Gatsby Tutorial Part Four.

plugins

Plugins are Node.js packages that implement Gatsby APIs. The config file accepts an array of plugins. Some plugins may need only to be listed by name, while others may take options (see the docs for individual plugins).

Installing a plugin using a package manager like npm does not enable it in your Gatsby site. To finish adding a plugin, make sure your gatsby-config.js file has a plugins array so you can include a space for the plugins needed to build your site:

When adding multiple plugins, they should be separated by commas in the plugins array to support valid JavaScript syntax.

Plugins without options

If a plugin does not require any options, you can add its name as a string to the plugins array:

Plugins with options

Many plugins have optional or required options to configure them. Instead of adding a name string to the plugins array, add an object with its name and options. Most plugins show examples in their README file or page in the Gatsby plugin library.

Here’s an example showing how to write an object with keys to resolve the plugin name and an options object with any applicable settings:

Mixed plugins

You can add plugins with and without options in the same array. Your site’s config file could look like this:

See more about Plugins for more on utilizing plugins, and to see available official and community plugins.

flags

Flags let sites enable experimental or upcoming changes that are still in testing or waiting for the next major release.

Go here to see a list of the current flags.

pathPrefix

It’s common for sites to be hosted somewhere other than the root of their domain. Say you have a Gatsby site at example.com/blog. In this case, you would need a prefix (/blog) added to all paths on the site. The default setting for this option is "".

See more about Adding a Path Prefix.

trailingSlash

Support added in gatsby@4.7.0

Configures the creation of URLs for pages, and whether to remove, append, or ignore trailing slashes.

• always: Always add trailing slashes to each URL, e.g. /x to /x/.
• never: Remove all trailing slashes on each URL, e.g. /x/ to /x.
• ignore: Don’t automatically modify the URL

The default setting for this option is always. Gatsby Cloud automatically handles and supports the trailingSlash option. Alternate hosting providers (or if you’re managing this on your own) should follow the “Redirects, and expected behavior from the hosting provider” section on the initial RFC.

graphqlTypegen

Support added in gatsby@4.15.0

You can enable the GraphQL Typegen feature by setting graphqlTypegen to true. It’ll allow you to more easily incorporate content into your pages through automatic TypeScript type generation and better GraphQL IntelliSense.

Optionally, you can configure its behavior by passing an object to graphqlTypegen, see the options below. If you don’t pass an object (but graphqlTypegen: true), the default value for each option will be used.

typesOutputPath

Support added in gatsby@4.18.0

You can specify the path of the generated TypeScript types file relative to the site root. Default: src/gatsby-types.d.ts.

documentSearchPaths

Support added in gatsby@5.3.0

You can overwrite the search paths, which contain documents that should be scanned. Usually you want to include the default values and append your additional paths. Default: [`./gatsby-node.ts`, `./plugins/**/gatsby-node.ts`].

generateOnBuild

Support added in gatsby@4.22.0

By default, graphqlTypegen is only run during gatsby develop. Set this option to true to create the src/gatsby-types.d.ts file also during gatsby build. Default: false.

adapter

Support added in gatsby@5.12.0

You can set an adapter or configure zero-configuration deployments through the adapter setting.

Read the adapters guide to learn more.

headers

Support added in gatsby@5.12.0

You can set custom HTTP headers on the response of a given path.

Read the HTTP headers guide to learn more about header syntax, options, and behaviors.

polyfill

Gatsby uses the ES6 Promise API. Because some browsers don’t support this, Gatsby includes a Promise polyfill by default.

If you’d like to provide your own Promise polyfill, you can set polyfill to false.

See more about Browser Support in Gatsby.

Mapping node types

Please note: We strongly recommend using the @link GraphQL directive instead. It supports more use cases and will be the preferred method for foreign-keys in the future.

Gatsby includes a feature that lets you create “mappings” between node types.

For instance, imagine you have a multi-author markdown blog where you want to “link” from each blog post to the author information stored in a YAML file named author.yaml:

You can map between the author field in frontmatter to the name in the author.yaml objects by adding to your gatsby-config.js:

You may need to install the appropriate file transformer (in this case YAML) and set up gatsby-source-filesystem properly for Gatsby to pick up the mapping files. This applies to other file types later mentioned in this segment as well.

Gatsby then uses this mapping when creating the GraphQL schema to enable you to query data from both sources:

Mapping can also be used to map an array of ids to any other collection of data. For example, if you have two JSON files experience.json and tech.json as follows:

And then add the following rule to your gatsby-config.js:

You can query the tech object via the referred items in experience:

Mapping also works between Markdown files. For example, instead of having all authors in a YAML file, you could have info about each author in a separate Markdown file:

And then add the following rule to your gatsby-config.js:

Similarly to YAML and JSON files, mapping between Markdown files can also be used to map an array of ids.

Proxy

Setting the proxy config option will tell the develop server to proxy any unknown requests to your specified server. For example:

See more about Proxying API Requests in Develop.

Advanced proxying with developMiddleware

See more about adding develop middleware.

jsxRuntime

Setting to automatic allows the use of JSX without having to import React. More information can be found on the Introducing the new JSX Transform blog post.

jsxImportSource

When jsxRuntime is set you can choose which package React should use as underlying JSX transformer with jsxImportSource. For example you can set it to @emotion/react so by default @emotion/react is used instead of the react package.

Please note: For now you’ll also need to set this configuration inside babel-preset-gatsby, see its jsxImportSource documentation.