Grunt plugin to generate XML sitemap index files
This plugin requires Grunt
~0.4.5 and Node
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-index --save-dev
The "sitemap_index" task
sitemap_index task generates a sitemap index file, as described at sitemaps.org.
In your project's Gruntfile, add a section named
sitemap_index to the data object passed into
URL used as a prefix for all URLs included in the sitemap. This is a required option.
Determines whether the sitemap index file should be compressed using
gzip or not.
This example shows the default usage, without any options.
Note that you should always specify the
baseurl option, as otherwise your sitemap will contain incorrect URLs.
This example shows how to generate a sitemap index file for the domain 'mydomain.com'. The index file will not be compressed.
Changing working directory
Generally, in order to get the correct paths to the sitemaps, you will want to use a file specification that includes the
cwd element. For example, if your build directory for production is
build/production, and your sitemaps live in the root of your document tree, you'd want to set
build/production so that you generate URLs of the form
http://yourdomain.com/your-sitemap.xml.gz. If you don't use
cwd, you're likely to end up with a URL like
http://yourdomain.com/build/production/your-sitemap.xml.gz, which is probably not what you want.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
- 2015-03-07 v0.1.0 Initial release