gatsby-plugin-prismic-preview

    2.0.0 • Public • Published

    Prismic preview

    Enable previews of your prismic documents

    Installing

    Install module

    npm install --save gatsby-plugin-prismic-preview

    Add plugin to gatsby-config.js:

    {
      resolve: 'gatsby-plugin-prismic-preview',
      options: {
        repositoryName: 'gatsby-source-prismic-test-site',
        linkResolver: require('./src/linkResolver'),
        path: '/preview',
      }
    }

    Configuration

    repositoryName

    Should be the same as the one in gatsby-source-prismic plugin

    linkResolver

    Inline function

    options: {
      linkResolver(doc) {
        if (doc.type === 'BlogPost') {
          return `/blog/${doc.uid}`;
        }
        return `${doc.type}`;
      },
    },

    or a require to a specific file (must be ES5 module.exports format)

    options: {
      linkResolver: require('./src/utils/linkResolver'),
    },

    path

    Where the preview page should live.

    Defaults to /preview.

    Staging environment

    Only allow previews on staging? In gatsby-config.js do a conditional operation:

    const plugins = [
      'plugin-1',
      'plugin-2',
    ];
     
    if (process.env.NODE_ENV === 'staging') {
      plugins.push({
        resolve: 'gatsby-plugin-prismic-preview',
        options: {}
      });
    }
     
    module.exports = {
      siteMetadata: {
        title: 'Gatsby Default Starter',
      },
      plugins,
    };

    Troubleshooting

    Install

    npm i gatsby-plugin-prismic-preview

    DownloadsWeekly Downloads

    1,146

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    17.5 kB

    Total Files

    7

    Last publish

    Collaborators

    • birkir