Gatsby Config API
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.
gatsby-config.js file could look like this:
The TypeScript and Gatsby documentation shows how to set up a configuration file in TypeScript.
Options available to set within
- siteMetadata (object)
- plugins (array)
- flags (object)
- pathPrefix (string)
- trailingSlash (string)
- graphqlTypegen (boolean)
- polyfill (boolean)
- mapping (object)
- proxy (object)
- developMiddleware (function)
- jsxRuntime (string)
- jsxImportSource (string)
When you want to reuse common pieces of data across the site (for example, your site title), you can store that data in
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 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
If a plugin does not require any options, you can add its name as a string to the
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:
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 let sites enable experimental or upcoming changes that are still in testing or waiting for the next major release.
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.
See more about Adding a Path Prefix.
Support added in
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.
never: Remove all trailing slashes on each URL, e.g.
ignore: Don’t automatically modify the URL
The default setting for this option is
legacy in order to preserve existing behavior for current users. In Gatsby v5 the default mode will be
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.
Support added in
You can enable the GraphQL Typegen feature by setting
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.
You can specify the path of the generated TypeScript types file relative to the site root. 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:
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
See more about Browser Support in Gatsby.
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
You can map between the
author field in
frontmatter to the
name in the
author.yaml objects by adding to your
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
tech.json as follows:
And then add the following rule to your
You can query the
tech object via the referred items in
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
Similarly to YAML and JSON files, mapping between Markdown files can also be used to map an array of ids.
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.
See more about adding develop middleware.
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.
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
Please note: For now you’ll also need to set this configuration inside
babel-preset-gatsby, see its jsxImportSource documentation.