Skip to content
Branch: master
Find file History
hjvedvik chore(release): publish
 - gridsome@0.6.3
 - @gridsome/plugin-sitemap@0.2.1
 - @gridsome/remark-prismjs@0.0.6
 - @gridsome/source-ghost@0.1.0
Latest commit 7ed2bd6 May 27, 2019
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
CHANGELOG.md
README.md feat(sitemap): add support for static urls (#392) May 15, 2019
index.js
package.json chore(release): publish May 27, 2019

README.md

@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.

You can’t perform that action at this time.