Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including @gridsome/plugin-sitemap with all npm packages installed. Try it out:

var pluginSitemap = require("@gridsome/plugin-sitemap")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@gridsome/plugin-sitemap v0.2.3

Generate sitemap for Gridsome sites

@gridsome/plugin-sitemap

Generate sitemap for Gridsome sites

Install

  • yarn add @gridsome/plugin-sitemap
  • npm install @gridsome/plugin-sitemap

Usage

Make sure siteUrl is set in your project config. All rendered pages (except /404) are included in the resulting XML. The config option can be used to set a custom changefreq or priority per path or a glob pattern for multiple paths.

module.exports = {
  plugins: [
    {
      use: '@gridsome/plugin-sitemap',
      options: {
        cacheTime: 600000, // default
        exclude: ['/exclude-me'],
        config: {
          '/articles/*': {
            changefreq: 'weekly',
            priority: 0.5
          },
          '/about': {
            changefreq: 'monthly',
            priority: 0.7
          }
        }
      }
    }
  ]
}

Adding static urls

module.exports = {
  plugins: [
    {
      use: '@gridsome/plugin-sitemap',
      options: {
        staticUrls: [
          {
            url: '/images/',
            img: [
              {
                url: '/images/img1.jpg',
                caption: 'Image One',
                title: 'The Title of Image One',
                geoLocation: 'Trondheim, Norway',
                license: 'https://creativecommons.org/licenses/by/4.0/'
              },
              {
                url: '/images/img2.jpg',
                caption: 'Image Two',
                title: 'The Title of Image Two',
                geoLocation: 'Trondheim, Norway',
                license: 'https://creativecommons.org/licenses/by/4.0/'
              }
            ]
          }
        ]
      }
    }
  ]
}

Your sitemap will be available at /sitemap.xml after your site is built.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free