gatsby-config.js

const path = require('path');
const { global } = require('@storybook/design-system');
const siteMetadata = require('./site-metadata');
const getReleaseBranchUrl = require('./src/util/get-release-branch-url');
const { versionsWithToc } = require('./src/util/versions');

require('dotenv').config({
  path: `.env.${process.env.NODE_ENV}`,
});

module.exports = {
  siteMetadata,
  trailingSlash: 'never',
  flags: {
    FAST_DEV: true,
    QUERY_ON_DEMAND: true,
  },
  ...(!siteMetadata.isLatest
    ? { assetPrefix: getReleaseBranchUrl(siteMetadata.versionString) }
    : undefined),
  plugins: [
    'gatsby-plugin-react-helmet',
    'gatsby-plugin-typescript',
    {
      resolve: `gatsby-source-filesystem`,
      options: {
        name: `images`,
        path: `${__dirname}/src/images`,
      },
    },
    {
      resolve: 'gatsby-source-graphql',
      options: {
        fieldName: `integrations`,
        url: `https://boring-heisenberg-43a6ed.netlify.app/`,
        typeName: `INTEGRATION`,
      },
    },
    {
      resolve: 'gatsby-source-graphql',
      options: {
        fieldName: `storybookProjects`,
        url: `https://api-us-west-2.hygraph.com/v2/ckyko33ox031l01xo8a944g1b/master`,
        typeName: `STORYBOOK_PROJECTS`,
        headers: {
          Authorization: `Bearer ${process.env.GRAPHCMS_PAT}`,
        },
      },
    },
    'gatsby-transformer-sharp',
    'gatsby-plugin-sharp',
    {
      resolve: `gatsby-plugin-manifest`,
      options: {
        name: 'gatsby-starter-default',
        short_name: 'starter',
        start_url: '/',
        icon: 'src/images/logos/icon-storybook.svg',
      },
    },
    {
      resolve: 'gatsby-plugin-web-font-loader',
      options: {
        custom: {
          urls: [global.fontUrl],
        },
      },
    },
    `gatsby-plugin-emotion`,
    {
      resolve: 'gatsby-plugin-segment-js',
      options: {
        // This plugin requires prodKey despite the fact that we instruct
        // the plugin to avoid using it with the manualLoad option. We call
        // analytics.load(SEGMENT_WRITE_KEY) manually so we can avoid having
        // the script fire on iframe pages which load within Storybook.
        prodKey: process.env.GATSBY_SEGMENT_WRITE_KEY,
        manualLoad: true,
      },
    },
    {
      resolve: `gatsby-plugin-google-gtag`,
      options: {
        trackingIds: [process.env.GOOGLE_TAG_TRACKING_ID],
      },
    },
    {
      resolve: `gatsby-plugin-plausible`,
      options: {
        domain: `storybook.js.org`,
      },
    },
    {
      resolve: `gatsby-source-filesystem`,
      options: {
        name: `content`,
        path: `${__dirname}/src/content/`,
      },
    },
    // Make sure any symlinked packages are using the right version of React
    {
      resolve: `gatsby-plugin-alias-imports`,
      options: {
        alias: {
          react: path.resolve('./node_modules/react'),
        },
        extensions: ['js'],
      },
    },
    {
      resolve: `gatsby-plugin-mdx`,
      options: {
        extensions: ['.md', '.mdx'],
        gatsbyRemarkPlugins: [
          {
            resolve: 'gatsby-remark-link-rewrite',
            options: {
              // Strip off trailing .md from links. We want them there in the original source so the
              // relative links work inside github, when you view the .md files directly
              // (Note we need to ensure we don't match the links below)
              pattern: /^(?!\.\.\/\.\.\/)(?!https:\/\/github\.com\/)(.*)\.md(#.*)?$/,
              replace: '$1$2',
            },
          },
          {
            resolve: 'gatsby-remark-link-rewrite',
            options: {
              // Replace links that go to the monorepo (outside of docs) w/ full URLs to master
              pattern: /^\.\.\/\.\.\/(.*)$/,
              replace: 'https://github.com/storybookjs/storybook/tree/master/$1',
            },
          },
          {
            resolve: 'gatsby-remark-copy-linked-files',
            options: {
              ignoreFileExtensions: [],
            },
          },
          {
            resolve: `gatsby-remark-autolink-headers`,
            options: {
              icon: `<svg viewBox="0 0 1024 1024" width="18px" height="18px"><path d="M743.52 529.234c5.616-5.616 83.048-83.046 88.462-88.46 30.944-32.778 47.97-75.636 47.97-120.792 0-47.048-18.304-91.26-51.542-124.484-33.228-33.22-77.43-51.516-124.458-51.516-45.024 0-87.792 16.94-120.536 47.72l-104.458 104.456c-30.792 32.738-47.734 75.512-47.734 120.548 0 41.916 14.576 81.544 41.248 113.196 3.264 3.876 6.666 7.664 10.292 11.29 4.258 4.258 8.704 8.262 13.304 12.022 0.054 0.080 0.096 0.152 0.148 0.232 9.572 7.308 15.778 18.804 15.778 31.776 0 22.094-17.914 40-40.004 40-8.542 0-16.442-2.696-22.938-7.26-2.746-1.93-20.622-17.43-30.35-28.050-0.008-0.010-0.018-0.018-0.026-0.028-4.992-5.432-13.234-15.23-18.552-22.65s-16.556-25.872-17.036-26.736c-0.7-1.262-2.974-5.526-3.422-6.39-0.69-1.334-6.118-12.67-6.114-12.67-14.342-31.96-22.332-67.4-22.332-104.728 0-60.826 21.198-116.648 56.58-160.544 0.252-0.314 4.61-5.594 6.594-7.866 0.304-0.35 5.038-5.636 7.16-7.874 0.252-0.268 105.86-105.874 106.128-106.126 45.902-43.584 107.958-70.314 176.264-70.314 141.382 0 255.998 114.5 255.998 256 0 68.516-26.882 130.688-70.652 176.61-0.144 0.148-109.854 109.546-112.090 111.528-0.958 0.848-5.072 4.352-5.072 4.352-6.448 5.434-13.132 10.592-20.1 15.378 0.412-6.836 0.644-13.702 0.644-20.6 0-26.46-3.108-52.206-8.918-76.918l-0.236-1.102zM616.144 767.82c35.382-43.896 56.58-99.718 56.58-160.544 0-37.328-7.99-72.768-22.332-104.728 0.004 0 0.006-0.002 0.010-0.004-0.258-0.576-0.538-1.14-0.8-1.714-0.686-1.498-2.894-6.112-3.296-6.93-0.668-1.344-2.952-5.732-3.386-6.604-3.48-6.982-8.708-15.126-9.49-16.366-0.498-0.792-0.996-1.58-1.502-2.364-0.834-1.29-15.364-22.066-26.656-34.466-0.008-0.010-0.018-0.018-0.026-0.028-7.056-8.448-24.932-24.198-30.35-28.050-6.47-4.602-14.396-7.26-22.938-7.26-22.090 0-40.004 17.906-40.004 40 0 12.97 6.206 24.466 15.778 31.776 0.052 0.080 0.094 0.152 0.148 0.232 4.602 3.76 20.334 19.434 23.598 23.31 26.672 31.65 41.248 71.28 41.248 113.196 0 45.038-16.944 87.81-47.734 120.548l-104.458 104.456c-32.742 30.782-75.512 47.72-120.536 47.72-47.028 0-91.228-18.294-124.458-51.516-33.236-33.224-51.542-77.436-51.542-124.484 0-45.154 17.028-88.014 47.97-120.792 5.414-5.414 40.812-40.812 68.958-68.958 7.176-7.176 13.888-13.886 19.504-19.502v-0.002c-0.356-1.562-0.246-1.096-0.246-1.096-5.81-24.712-8.918-50.458-8.918-76.918 0-6.898 0.232-13.764 0.644-20.6-6.966 4.788-20.1 15.33-20.1 15.33-0.734 0.62-9.518 8.388-11.68 10.45-0.16 0.154-105.338 105.33-105.482 105.478-43.77 45.922-70.652 108.094-70.652 176.61 0 141.5 114.616 256 255.998 256 68.306 0 130.362-26.73 176.264-70.314 0.27-0.254 105.876-105.86 106.128-106.126 0.004-0.002 13.506-15.426 13.758-15.74z"></path></svg>`,
              className: `remark-header-link`,
              maintainCase: false,
              removeAccents: true,
              isIconAfterHeader: false,
            },
          },
          'gatsby-remark-check-links',
        ],
      },
    },
    // this (optional) plugin enables Progressive Web App + Offline functionality
    // To learn more, visit: https://gatsby.app/offline
    // 'gatsby-plugin-offline',
    {
      resolve: 'gatsby-plugin-netlify',
      options: {
        headers: {
          // Remove `X-Frame-Options: DENY` default header so that the release notes can
          // be served in an iframe.
          '/*': [
            'X-XSS-Protection: 1; mode=block',
            'X-Content-Type-Options: nosniff',
            ...(!siteMetadata.isLatest ? ['Access-Control-Allow-Origin: *'] : []),
          ],
          '/versions.json': [
            'Access-Control-Allow-Origin: *',
            'Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept',
          ],
          ...(!siteMetadata.isLatest && {
            [`/docs/${siteMetadata.versionString}/*`]: ['X-Robots-Tag: noindex'],
          }),
        },
        // Do not use the default security headers. Use those we have defined above.
        mergeSecurityHeaders: false,
      },
    },
    'gatsby-plugin-remove-trailing-slashes',
    {
      resolve: 'gatsby-plugin-layout',
      options: {
        component: require.resolve('./src/components/layout/PageLayout'),
      },
    },
    ...(siteMetadata.isLatest
      ? [
          {
            resolve: `gatsby-plugin-sitemap`,
            options: {
              query: `
                {
                  site {
                    siteMetadata {
                      siteUrl
                    }
                  }
                  allSitePage {
                    nodes {
                      path
                    }
                  }
                }
              `,
              resolvePages: ({
                site: {
                  siteMetadata: { siteUrl },
                },
                allSitePage: { nodes: allPages },
              }) =>
                allPages.map((page) => ({
                  url: `${siteUrl}${page.path}/`,
                  ...page,
                })),
              serialize: ({ url }) => ({ url }),
            },
          },
          {
            // Generate a sitemap for all pages, all versions
            resolve: `gatsby-plugin-sitemap`,
            options: {
              output: '/sitemap-all',
              query: `
                {
                  site {
                    siteMetadata {
                      siteUrl
                    }
                  }
                  allSitePage {
                    nodes {
                      path
                    }
                  }
                }
              `,
              resolvePages: ({
                site: {
                  siteMetadata: { siteUrl },
                },
                allSitePage: { nodes: allPages },
              }) => {
                const latestPages = allPages.map((page) => ({
                  url: `${siteUrl}${page.path}/`,
                  ...page,
                }));

                const nonLatestDocsPages = [];
                versionsWithToc.forEach(({ string, toc }) => {
                  const createDocsPageEntries = (tocItems, pathPrefix) => {
                    tocItems.forEach(({ children, pathSegment }) => {
                      const pagePath = pathSegment ? `${pathPrefix}/${pathSegment}` : pathPrefix;

                      if (pathSegment) {
                        nonLatestDocsPages.push({
                          url: `${siteUrl}${pagePath}/`,
                          path: `${pagePath}/`,
                        });
                      }

                      if (children) {
                        createDocsPageEntries(children, pagePath);
                      }
                    });
                  };

                  createDocsPageEntries(
                    toc,
                    string !== siteMetadata.latestVersionString ? `/docs/${string}` : '/docs'
                  );
                });

                return [...latestPages, ...nonLatestDocsPages];
              },
              serialize: ({ url }) => ({ url }),
            },
          },
        ]
      : []),
  ],
};