Gatsby

Welcome to the developer documentation of Prismic and Gatsby, "a free and open-source framework based on React that helps developers build blazing-fast websites and apps," as explained in the official Gatsby website.

This page outlines some of the resources that'll help you start with your project.

Select the best option to get started with your Gatsby.js and Prismic project.

If you don't have a project yet, we recommend starting from scratch using the tutorial or a sample project.

If you already have an existing Gatsby project and want to integrate Prismic, this documentation will teach you how to install the necessary plugins, make queries, template content, and much more.

Check out our resources for integrating a Gatsby project with Prismic. Start by reading how to configure the plugin, then learn much more: Add languages and localization, configure Previews, etc.

In general, Gatsby plugins help developers customize and extend their application capabilities. Gatsby is a framework that offers a wide variety of plugins that allows you to power up your Gatsby site.

In this documentation, we focus on the ones we officially recommend: gatsby-source-prismic and gatsby-plugin-prismic-previews.

The gatsby-source-prismic source plugin helps you to pull data from Prismic. All the articles you will find in further sections document this plugin's usage.

This plugin works together with gatsby-source-prismic to allow you to Integrate live Prismic Previews into a static Gatsby site to enable editors a seamless content editing experience.

We've moved away from supporting and documenting this plugin.

We have a dedicated article if you're interested in learning the details about this process: Gatsby-Prismic plugins: what’s going on?

We highly recommend that you migrate your project to gatsby-source-prismic with the help of this guide: