assemble-contrib-sitemap

assemble-contrib-sitemap

Sitemap generator plugin for Assemble

Table of Contents

• Quickstart
• Options
• Usage Examples
• Contributing
• Author
• Release History
• License

Quickstart

From the same directory as your project's Gruntfile and package.json, install this plugin with the following command:

npm install assemble-contrib-sitemap --save

Once that's done, just add assemble-contrib-sitemap, the name of this module, to the plugins option in the Assemble task:

module.exports = function(grunt) {

  // Project configuration.
  grunt.initConfig({
    assemble: {
      options: {
        plugins: ['assemble-contrib-sitemap']
      },
      ...
    }
  });
  grunt.loadNpmTasks('assemble');
  grunt.registerTask('default', ['assemble']);
};

If everything was installed and configured correctly, you should be ready to go!

Options

See sitemaps.org for detail XML tag definitions.

homepage

Type: String
Default: homepage (from package.json)

Site URL

changefreq

Type: String
Default: 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

priority

Type: String
Default: weekly

The priority of this URL relative to other URLs on your site. Valid values range from 0.0 to 1.0. This value does not affect how your pages are compared to pages on other sites—it only lets the search engines know which pages you deem most important for the crawlers.

exclusions

Type: Array
Default: ['404']

Page to omit from the sitemap.

options: {
  sitemap: {
    exclusions: ["foo", "bar"],
  },
  files: {
    ...
  }
}

robot

Type: Boolean
Default: true

Generate robots.txt from exclusions list.

Usage Examples

Simple

To simplify might do something like:

assemble: {
  blog: {
    options: {
      plugins: ['assemble-contrib-sitemap'],
    },
    files: {
      './blog/': ['./templates/blog/*.hbs']
    }
  }
}

Result

./blog/sitemap.xml
./blog/robots.txt

Advanced

assemble: {
  blog: {
    options: {
      plugins: ['assemble-contrib-sitemap'],
      sitemap: {
        homepage: 'http://assemble.io',
            changefreq: 'daily',
            priority: '0.8',
            exclude: ['50x', 'foo'],
            robot: false
      }
    },
    files: {
      './blog/': ['./templates/blog/*.hbs']
    }
  }
}

Result

./blog/sitemap.xml

Contributing

We welcome all kinds of contributions! The most basic way to show your support is to star the project, and if you'd like to get involed please see the Contributing to assemble-contrib-sitemap guide for information on contributing to this project.

Author

Hariadi Hinta

• github.com/hariadi
• twitter.com/hariadi

Release History

• 2013-02-05   v0.2.0   Generation of robots.txt will now respect the relativedest option.
• 2013-02-02   v0.1.9   Fix sitemap destination
• 2013-01-28   v0.1.8   Use external library Get pages from assemble object
• 2013-01-03   v0.1.7   Add relativedest option
• 2013-12-12   v0.1.6   Fix plugin name in Usage Examples Update deps
• 2013-11-28   v0.1.4   Updates dependencies to work with Grunt 0.4.2 [object Object] Add TOC to docs
• 2013-10-20   v0.1.3   Fix sitemap and robots.txt generated on every folder Update docs options:exclusions
• 2013-10-18   v0.1.2   Fix homepage
• 2013-10-17   v0.1.1   Add option to generate robots.txt Change name to assemble-contrib.sitemap Move to Assemble main repo
• 2013-10-01   v0.1.0   First commmit. Add option to exclude

License

Copyright (c) 2014 Hariadi Hinta, contributors. Released under the license

---

This file was generated on Thursday, February 5, 2014.