Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Grunt plugin for generating sitemaps
CoffeeScript
branch: master
Failed to load latest commit information.
src merge and bump
tasks Update dependencies.
.gitignore Update .gitignore.
Cakefile Fix issue when building on Windows.
LICENSE-MIT Initial src commit
README.md Update README.md.
package.json Bump lodash to 3.3.0.

README.md

grunt-sitemap

A Grunt plugin for generating sitemaps

NPM version Dependency Status devDependency Status

Installation

This plugin requires Grunt ~0.4.5.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-sitemap --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-sitemap');

Configuration

sitemap is a multitask, so you can use it similarly to lint, watch etc...

grunt.initConfig({

  sitemap: {
    dist: {
      pattern: ['**/*.html', '!**/google*.html'], // this will exclude 'google*.html'
      siteRoot: 'public/'
    }
  }

});

Options

siteRoot

  • Type: string
  • Default: ./

Site (public root) directory relative to your Gruntfile.js file. This is where indexing will begin and your sitemap be saved to.

pattern

  • Type: string
  • Default: /**/*.html

Pattern to match website files. Excludes 404.html by default and converts index.html to directory path /. See minimatch for more on pattern matching.

homepage

  • Type: string
  • Default: read from package.json

Site URL including protocol: e.g. http://www.example.com If the homepage field is specified in your package.json, it will be used from there.

changefreq

  • Type: string
  • Default: daily

Set this to override <changefreq> in sitemap.

priority

  • Type: string
  • Default: 0.5

Set this to override <priority> in sitemap.

extension

  • Type: object
  • Default: { required: true }

E.g.

extension: {
  required: false
}

If you need a trailing slash just set the attribute trailingSlash: true. E.g.

extension: {
  required: false,
  trailingSlash: true
}

By default the <loc> tag is generated for paths that contains file extensions. E.g.: .html or .htm. If you don't want URLs with file extensions to be included in your sitemap, just add the attribute extension: { required: false }. This will output URLs without file extensions.

Contributing

We accept pull requests! A special thanks to XhmikosR for keeping things rolling.

Something went wrong with that request. Please try again.