README.md

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.

Usage

For each document, you can specify the following metadata:

changefreq: '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'

Install

Install this DocPad plugin by entering docpad install sitemap into your terminal.

History

Discover the release 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 — view contributions
• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Anton Poleshchuk — view contributions
• Ben Delarre — view contributions
• Benjamin Lupton — view contributions
• Bruno Heridet — view contributions
• Evan Bovie — view contributions
• Khalid Jebbari — view contributions
• Nathan Bowser — view contributions
• Rafael Epplée
• Rafael Epplée — view contributions
• Rob Loach — view contributions
• brockfanning — view contributions
• vsopvsop — view contributions

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

License

Unless stated otherwise all works are:

• Copyright © 2012+ Ben Delarre

and licensed under:

• MIT License