gatsby-config.js

const path = require('path');

const queries = require('./src/utils/algolia');
const { isProduction } = require('./src/utils/utils.node');

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

const shouldAnnouncementBannerBeShown = false;

const plugins = [
  'gatsby-transformer-sharp',
  {
    resolve: 'gatsby-plugin-sharp',
    options: {
      defaults: {
        quality: 90,
        placeholder: 'none',
      },
    },
  },
  'gatsby-plugin-image',
  'gatsby-plugin-catch-links',
  'gatsby-plugin-resolve-src',
  'gatsby-transformer-json',
  {
    resolve: 'gatsby-plugin-manifest',
    options: {
      name: 'k6',
      short_name: 'k6',
      start_url: '/',
      background_color: '#fff',
      theme_color: '#BADA55',
      display: 'minimal-ui',
      icon: './src/images/favicon.png',
    },
  },
  {
    resolve: 'gatsby-source-filesystem',
    options: {
      name: 'data',
      path: `${__dirname}/src/data/`,
    },
  },
  {
    resolve: 'gatsby-source-filesystem',
    options: {
      name: 'images',
      path: `${__dirname}/src/images`,
    },
  },
  {
    resolve: 'gatsby-source-filesystem',
    options: {
      name: 'markdown',
      path: `${__dirname}/src/data/markdown`,
    },
  },
  {
    resolve: 'gatsby-plugin-mdx',
    options: {
      extensions: ['.md'],
      gatsbyRemarkPlugins: [
        {
          resolve: 'gatsby-remark-relative-images',
        },
        {
          resolve: 'gatsby-remark-copy-linked-files',
        },
        {
          resolve: 'gatsby-remark-images',
          options: {
            maxWidth: 800,
            quality: 90,
            withWebp: true,
            disableBgImage: true,
            wrapperStyle: 'margin-left: 0;',
            showCaptions: ['title'],
          },
        },
      ],
    },
  },
  {
    resolve: 'gatsby-plugin-google-fonts',
    options: {
      fonts: ['roboto mono:300,400'],
    },
  },
  {
    resolve: 'gatsby-plugin-svgr-svgo',
    options: {
      inlineSvgOptions: [
        {
          test: /\.inline.svg$/,
          svgoConfig: {
            plugins: [
              {
                name: 'preset-default',
                params: {
                  overrides: {
                    removeViewBox: false,
                  },
                },
              },
              'prefixIds',
            ],
          },
        },
      ],
      urlSvgOptions: [
        {
          test: /\.svg$/,
          svgoConfig: {
            plugins: [
              {
                name: 'preset-default',
                params: {
                  overrides: {
                    removeViewBox: false,
                  },
                },
              },
            ],
          },
        },
      ],
    },
  },
  {
    resolve: 'gatsby-plugin-sass',
    options: {
      additionalData:
        '@import "./src/styles/variables.scss", "./src/styles/mixins.scss";',
      useResolveUrlLoader: true,
      cssLoaderOptions: {
        modules: {
          namedExport: false,
          exportLocalsConvention: 'camelCase',
        },
      },
    },
  },
  {
    resolve: 'gatsby-plugin-sitemap',
    options: {
      excludes: ['/get-started/welcome', '/docs/get-started/welcome'],
    },
  },
  {
    resolve: `@tmttn/gatsby-plugin-linkedin-insight`,
    options: {
      partnerId: '4981058',
      includeInDevelopment: false,
    },
  },
];

if (
  process.env.ALGOLIA_ADMIN_KEY &&
  process.env.GATSBY_ALGOLIA_APP_ID &&
  process.env.GATSBY_ALGOLIA_SEARCH_ONLY_KEY
) {
  plugins.push({
    resolve: 'gatsby-plugin-algolia',
    options: {
      appId: process.env.GATSBY_ALGOLIA_APP_ID,
      apiKey: process.env.ALGOLIA_ADMIN_KEY,
      enablePartialUpdates: true,
      matchFields: ['title', 'slug', 'content', 'excerpt', 'heading'],
      queries,
      chunkSize: 10000, // default: 1000
    },
  });
}

if (shouldAnnouncementBannerBeShown) {
  // See more on how it works:
  // https://github.com/k6io/new.k6.io/pull/102
  const options = {
    banner: {
      componentPath: path.join(
        __dirname,
        './src/components/shared/announcement-banner/announcement-banner.js',
      ),
      text:
        // eslint-disable-next-line max-len
        '🎉 We have migrated the docs to the Grafana website! To check out the docs for the latest version of k6, head over to grafana.com/docs/k6.',
      link:
        // eslint-disable-next-line max-len
        'https://grafana.com/docs/k6/latest/',
      buttonText: 'Learn more',
    },
    // settings below have to match
    // settings in other repos to avoid
    // unpredictable behavior
    cookie: {
      name: 'k6-announcement-banner-is-hidden',
      consentBannerCookieName: 'user-has-accepted-cookies',
      expiration: {
        days: 60,
      },
    },
    storage: {
      // changing storage name to force users to see the banner even if it was disabled
      name: 'k6-db-was-shown',
    },
  };
  if (isProduction) {
    // enabling GA in prod
    options.ga = {
      label: 'docs',
      action: 'Click',
      readMoreButtonCategory: 'BannerAnnouncementReadMore',
      dismissButtonCategory: 'BannerAnnouncementDismiss',
    };
  }

  plugins.push({
    resolve: 'gatsby-plugin-announcement-banner',
    options,
  });
}

if (isProduction) {
  plugins.push({
    resolve: 'gatsby-plugin-google-tagmanager',
    options: {
      id: 'GTM-KBV9L4L',
      includeInDevelopment: false,
    },
  });

  plugins.push({
    resolve: '@sentry/gatsby',
    options: {
      dsn: 'https://f46b8e24a5374539ba179e52835913e3@o175050.ingest.sentry.io/5289132',
      environment: 'production',
    },
  });
}

if (process.env.BUCKET_NAME) {
  plugins.push({
    resolve: `gatsby-plugin-s3`,
    options: {
      generateRedirectObjectsForPermanentRedirects: true,
      bucketName: process.env.BUCKET_NAME,
      region: process.env.BUCKET_REGION,
      protocol: 'https',
      hostname: isProduction ? 'k6.io' : 'staging.k6.io',
    },
  });
}

module.exports = {
  pathPrefix: process.env.PATH_PREFIX || `/docs`,
  trailingSlash: 'always',
  siteMetadata: {
    siteTitle:
      'Docs k6.io - Performance testing for developers, like unit-testing, for performance', // <title>
    shortSiteTitle: 'k6', // <title> ending for posts and pages
    siteDescription:
      // eslint-disable-next-line max-len
      'Grafana k6 is an open source developer-centric load and performance regression testing tool for cloud native APIs, microservices and web sites/apps. Tests are written in ES6 JS with support for HTTP/1.1, HTTP/2.0 and WebSocket protocols.',
    siteImage: '/images/k6-cover-image.png',
    siteUrl: process.env.GATSBY_DEFAULT_MAIN_URL,
    authorName: 'k6',
    authorTwitterAccount: '@k6_io',
  },
  plugins,
};