Sitemap Plugin for DocPad

This DocPad plugin will automatically generate a valid sitemap.xml file for search engines. It's merely a wrapper for the sitemap.js library.

This project was forked from the solid start made by Khalid Jebbari.

To learn more about sitemap.xml files, read the protocol.

Installation

docpad install sitemap

Usage

For each document, you can specify the following metadata :

changfreq: 'always' || 'hourly' || 'daily' || 'weekly' || 'monthly' || 'yearly' || 'never' # Change frequency, defaults to 'weekly'
priority: 0.5 # value between 0.0 and 1.0, defaults to 0.5
sitemap: true || false # defaults to true, if false no entry for this document will be generated

For the whole site you can set defaults using the plugin configuration in your docpad.cson or docpad.coffee file.

	templateData:
		site:
			url: "http://your-website-production-url.com"  # required for sitemap
	
	plugins:
		sitemap:
			cachetime: 600000
			changefreq: 'weekly'
			priority: 0.5
			filePath: 'sitemap.xml'

By default all HTML files on your site will be considered for inclusion. To specify a different collection, change the collectionName plugin configuration option like so:

	plugins:
		sitemap:
			collectionName: 'someCollectionName'

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Ben Delarre ben@delarre.net (http://www.delarre.net)
Benjamin Lupton b@lupton.cc (https://github.com/balupton)

Contributors

These amazing people have contributed code to this project:

Ben Delarre ben@delarre.net (https://github.com/benjamind) - view contributions
Benjamin Lupton b@lupton.cc (https://github.com/balupton) - view contributions
Bruno Heridet (https://github.com/Delapouite) - view contributions
Khalid Jebbari khalid.jebbari@gmail.com (https://github.com/DjebbZ) - view contributions
raffomania (https://github.com/raffomania) - view contributions

Become a contributor!

License

Licensed under the incredibly permissive MIT license

apoleshchuk / docpad-plugin-sitemap