Reference Guides

Learn more about how Gatsby Cloud allows you to build, integrate, and deploy Gatsby sites with exceptional speed and reliability.

• Working with Environment Variables
• Environment Variables Specific to Gatsby Cloud
• Production Builds and Pull Request Builds
See all 13

Browse CLI commands like gatsby build and gatsby develop and typical folders and files you'll see inside a Gatsby project.

• Gatsby Project Structure
• Gatsby CLI commands
• Fast Refresh

Gatsby Link, Gatsby Script, Gatsby Head, and the Gatsby Image plugin are drop-in components that improve your site's performance and users' experience.

• Gatsby Link API
• Gatsby Script API
• Gatsby Head API

Generate templated pages like blog posts or products with file system routing.

• Creating Routes
• File System Route API

Inside its configuration files, Gatsby provides a rich set of lifecycle APIs to hook into its bootstrap, build, and client runtime operations. They allow sourcing data, creating pages, and customizing generated HTML pages.

• Gatsby Config APIs
• Gatsby Node APIs

Functions let you build dynamic applications without running servers. Submit forms, authenticate users, securely connect to external services, build GraphQL/REST APIs, and more.

• Getting Started
• Routing
• Middleware & Helpers

APIs for querying your data (PageQuery, StaticQuery, Fragments) and specifying your GraphQL schema (schema customization).

• GraphQL Query API
• GraphQL Query Options Reference
• Customizing the GraphQL Schema
See all 4

Use rendering options to tell Gatsby when to build specific pages for your site. Choose between Static Site Generation, Deferred Static Generation, or Server-Side Rendering.

• Deferred Static Generation (DSG)
• Server-Side Rendering (SSR)

Find release notes and guides on how to upgrade Gatsby along with third-party packages.

• v4.24 Release Notes
• v4.23 Release Notes
• v4.22 Release Notes
See all 43