node package manager


DocPad plugin which automatically creates a sitemap.xml file from HTML file output.

Sitemap Plugin for DocPad

Build Status NPM version Gittip donate button Flattr donate button PayPayl donate button

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.


docpad install sitemap


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 file.

            url: ""  # required for 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:

            collectionName: 'someCollectionName'


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


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



These amazing people are maintaining this project:


No sponsors yet! Will you be the first?

Gittip donate button Flattr donate button PayPayl donate button


These amazing people have contributed code to this project:

Become a contributor!


Licensed under the incredibly permissive MIT license

Copyright © 2012+ Ben Delarre (