Plugin to create the sitemap.xml for your Punch sites.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.

Punch Sitemap Generator

Plugin to create the sitemap.xml for your Punch sites.

How to Use

  • Install the package

    npm install punch-sitemap-generator

  • Open your Punch project's configurations (config.json) and add the following:

      "plugins": {
      	"generator_hooks": {
      		"sitemap_generator": "punch-sitemap-generator"
  • Settings for the sitemap generator plugin must be specified under sitemap_generator in the config.json.

      "sitemap_generator": {
      	"url_root": ""	

You can set the following options for the sitemap_generator:

- `url_root` (**required**) - Root URL (host and protocol) of your published site.

- `changefreq` - Change frequency for all pages in the site (default `weekly`)

- `exclude_urls` - An array of full URLs to exclude from the sitemap (eg. ``).

- `manual_entries` - List of manual URL entries to include in the sitemap. (eg. `[ { "loc": "", "priority": "0.6", "lastmod": "2012-01-01", "changefreq": "yearly" } ]`)

- `url_extension` - The extension to add to the urls except if already present or if there is a trailing slash (eg. `.html`)
  • sitemap.xml will be generated along with the rest of the files in your site when you run the command punch generate (punch g). It will be stored in the output directory, ready to be published.


Copyright (c) 2012 Lakshan Perera
Licensed under the MIT license.