Gatsby

5.16.1 · active · verified Sat Apr 18

Gatsby is a free and open-source framework built on React for creating blazing-fast websites and apps. It supports various data sources like Markdown, headless CMS, and GraphQL APIs, offering Static Site Generation (SSG), Deferred Static Generation (DSG), and Server-Side Rendering (SSR) options. Version 5.16.1 is the current stable release, with frequent patch and minor updates.

Common errors

```
error glob@11.0.3: The engine "node" is incompatible with this module. Expected version "20 || >=22". Got "18.6.0"
```
cause A transitive dependency `glob` has a strict Node.js version requirement that might conflict with Node.js 18.

fix Upgrade Gatsby to 5.14.6 or later, or use Node.js version 20 or 22.
```
isNonNullType is not defined
```
cause Compatibility issue with `webpack` versions equal to or greater than 5.99.0 during schema generation.

fix Upgrade Gatsby to 5.14.2 or later to fix this `webpack` compatibility issue.

Warnings

gotcha When using Node.js 22, it is highly recommended to use the latest 22.x release to avoid known issues with older versions.
Fix: Ensure you are running the latest patch version of Node.js 22 (e.g., 22.x.y where y is the highest).
gotcha Gatsby now formally supports React 19. Ensure your project's React dependencies are updated if you intend to use React 19.
Fix: Update your `react` and `react-dom` peer dependencies to `^19.0.0`.
gotcha Users of Gatsby Head API (e.g., for setting document title) might have experienced regressions where `<title>` tags did not update `document.title` correctly.
Fix: Upgrade to Gatsby 5.16.1 or later to resolve these issues.
breaking The `gatsby-source-shopify` plugin was upgraded to use Shopify API version 2024-04 from 2022-04, which may introduce breaking changes for existing Shopify integrations.
Fix: Review the Shopify API 2024-04 release notes and update your data queries or component logic as necessary.
gotcha Some Node.js 18 users might encounter `npm install` errors related to `glob` engine incompatibility with certain transitive dependencies.
Fix: Gatsby 5.14.6 includes a fix for this by using a forked `devcert`. Ensure you are on Gatsby 5.14.6 or later, or consider upgrading to Node.js 20 or 22 if the issue persists.

Install

npm install gatsby npm
yarn add gatsby yarn
pnpm add gatsby pnpm

Imports

Link
```
import { Link } from 'gatsby'
```
Head
```
import { Head } from 'gatsby'
```

Quickstart

This command creates a new Gatsby project, navigates into its directory, and starts the development server, making the site accessible at localhost:8000.

gatsby new my-gatsby-site
cd my-gatsby-site
gatsby develop

view raw JSON →