Gatsby Contentful starter for creating a blog.


  • Simple content model and structure. Easy to adjust to your needs.
  • Contentful integration using our Sync API
  • Using our Delivery API.
  • Responsive/adaptive images via gatsby-image


This project is part of contentful-userland which means that we’re always open to contributions and you can be part of userland and shape the project yourself after your first merged pull request. You can learn more about how contentful userland is organized by visiting our about repository.


To use this project you have to have a Contentful account. If you don't have one yet you can register at

Getting started

Install Yarn (if you haven't already).

Get the source code and install dependencies.

$ git clone [email protected]:contentful-userland/gatsby-contentful-starter.git
$ yarn install

Or use the Gatsby CLI.

$ gatsby new contentful-starter

Set up of the needed content model and create a configuration file

This project comes with a Contentful setup command yarn run setup.

Command line dialog of the yarn run setup command

This command will ask you for a space ID, and access tokens for the Contentful Management and Delivery API and then import the needed content model into the space you define and write a config file (./contentful.json).

yarn run setup automates that for you but if you want to do it yourself rename .contentful.json.sample to .contentful.json and add your configuration in this file.

Crucial Commands

This project comes with a few handy commands for linting and code fixing. The most important ones are the ones to develop and ship code. You can find the most important commands below.

yarn run dev

Run in the project locally.

yarn run build

Run a production build into ./public. The result is ready to be put on any static hosting you prefer.

yarn run deploy

Run a production build into ./public and publish the site to GitHub pages.

yarn run cleanup-repository

Removes all dependencies, scripts and data from the installation script.