Getting Started

Introduction

We hope you've gone through the Gatsby documention and know what it's all about. Also, our docs cover what's the real purpose of this plugin and its use case.

gatsby-starter-plone is a starter for Gatsby sites with Plone already setup with all the features, and so this tutorial guides you how to work your way from gatsby-starter-default, adding gatsby-source-plone and implementing features one by one to get gatsby-starter-plone as the end product. This way the tutorial covers how to generate a static site from a Plone site using gatsby-source-plone.

Setting up

Make sure you have Gatsby CLI installed globally, get started with gatsby-starter-default and add gatsby-source-plone with basic configuration:

gatsby new gatsby-starter-plone
yarn add gatsby-source-plone

In gatsby-starter-plone/gatsby-config.js add:

 plugins: [
    {
      resolve: 'gatsby-source-plone',
      options: {
        // Url of Plone site to use as source
        baseUrl: '<site-url-here>',
      },
    },
  ],

Configuring gatsby-config.js is covered in detail in the plugin options docs. Furthermore if your site is protected, go through the authentication docs to learn how to setup access with JWT.

Next: Querying Data with GraphQL