grunt-sitemap-xml
v0.3.0
Published
Grunt plugin for generating XML sitemaps for search engine indexing
Downloads
30
Readme
grunt-sitemap-xml
Grunt task for generating sitemap.xml
Getting Started
This plugin requires Grunt ~0.4.5
and Node.js 4.0.0
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-xml --save
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-sitemap-xml');
The "sitemap_xml" task
Overview
In your project's Gruntfile, add a section named sitemap_xml
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
sitemap_xml: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
}
});
Options
options.siteRoot
Type: String
Default value: pkg.homepage
A string value that is used to define the site root of the URL. Defaults to homepage from package.json.
options.stripIndex
Type: Boolean
Default value: true
A boolean value that is used to determine whether to strip index.html from the URL.
options.trailingSlash
Type: Boolean
Default value: true
Should trailing slash be stripped from the URL.
options.lastMod
Type: String
Default value: moment().format('YYYY-MM-DDTHH:mm:ssZ')
The date of last modification of the file. This date should be in W3C Datetime format.
options.priority
Type: String
Default value: 0.5
The priority of this URL relative to other URLs on your site. Valid values range from 0.0 to 1.0.
options.changeFreq
Type: String
Default value: weekly
How frequently the page is likely to change. This value provides general information to search engines and may not correlate exactly to how often they crawl the page. Valid values are:
- always
- hourly
- daily
- weekly
- monthly
- yearly
- never
options.pretty
Type: Boolean
Default value: false
A boolean value that is used to determine whether print the results indented with spaces
Usage Example
grunt.initConfig({
sitemap_xml: {
build: {
files: [
{
cwd: 'app/build',
src: '{,**/}*.html',
dest: 'app/build/sitemap.xml'
}
]
}
}
});
Contributing
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.
Release History
see CHANGELOG.md