This theme adds SEO related packages and configuration. The following packages are enabled by default:

• gatsby-plugin-react-helmet
• gatsby-plugin-catch-links
• gatsby-plugin-robots-txt
• gatsby-plugin-advanced-sitemap

These packages are also included, but not enabled by default:

• gatsby-plugin-google-tagmanager
• gatsby-plugin-force-trailing-slashes

Install

npm install @benrobertson/gatsby-theme-seo

Configure

In your gatsby-config.js:

module.exports = {
  plugins: [{
    resolve: 'gatsby-theme-seo',
    options: {
      // Adding variables in here will fail a build quickly and output
      // an error message. Useful for catching env errors quickly.
      requiredEnvVars: [
       'URL'
      ],

      // If true, forces trailing slashes.
      // Set to false by default.
      forceTrailingSlash: false,

      // The Google Tag Manager ID you want to add.
      // Will only add in production by default.
      gtmId: 'TEST-ID',

      // Optional configuration for robots.txt
      // See: https://www.gatsbyjs.org/packages/gatsby-plugin-robots-txt
      // Example:
      robotsOptions: {
        host: 'https://www.example-override.com',
        sitemap: 'https://www.example.com/sitemap.xml',
        policy: [{ userAgent: '*', allow: '/' }]
      },

      // Optional configuration for sitemaps.
      // For all available options, see:
      // https://www.gatsbyjs.org/packages/gatsby-plugin-advanced-sitemap/?=gatsby-plugin-advan#options
      // Example:
      sitemapOptions: {
       exclude: [
        '/404.html',
        '/404',
        '/dev-404-page',
        '/maintenance'
      }
    }
  }],
}