A metalsmith plugin for generating a sitemap.xml file with sitemap.js
JavaScript Makefile
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.editorconfig
.eslintrc
.gitattributes
.gitignore
.travis.yml
History.md
LICENSE
Makefile
README.md
package.json

README.md

metalsmith-mapsite

npm Build Status Dependency Status devDependency Status npm

A metalsmith plugin for generating a sitemap

This plugin allows you to generate a sitemap.xml from your source files. By default it looks for any .html files and processes them with sitemap.js.

Installation

$ npm install metalsmith-mapsite

CLI Usage

Configuration in metalsmith.json:

{
  "plugins": {
    "metalsmith-mapsite": {
      "hostname": "http://www.website.com"
    }
  }
}

JavaScript Usage

var sitemap = require('metalsmith-mapsite');

metalsmith(__dirname)
  .use(sitemap('http://www.website.com'))
  .build(function(err){
    if (err) throw err;
  });

Options

You can pass options to metalsmith-mapsite with the Javascript API or CLI. The options are:

hostname
  • required

The hostname used for generating the urls.

changefreq
  • optional
  • default: weekly

Change the default changefreq.

pattern
  • optional
  • default: '**/*.html'

A multimatch pattern. Only files that match this pattern will be included in the sitemap. Can be a string or an array of strings.

priority
  • optional
  • default: '0.5'

Change the default priority.

output
  • optional
  • default: 'sitemap.xml'

Change the output file for the sitemap.

lastmod
  • optional

Add a lastmodified date to the sitemap. Should be a Date object and can be passed through the Javascript API or the frontmatter.

omitExtension
  • optional
  • default: false

Will remove extensions from the urls in the sitemap. Useful when you're rewriting urls.

omitIndex
  • optional
  • default: false

Will replace any paths ending in index.html with ''. Useful when you're using metalsmith-permalinks.

Frontmatter

Some values can also be set on a file-to-file basis from a file's frontmatter, the options are:

  • canonical: will override the filename used to generate the url. The path is relative to the hostname.
  • changefreq: will override any other settings for changefreq for the current file.
  • lastmod: will override any other settings for lastmod for the current file.
  • priority: will override any other settings for priority for the current file.
  • private: will exclude the file from the sitemap when set to true.

For example:

---
canonical: 'different'
changefreq: always
lastmod: 2014-12-01
priority: 1.0
private: true
---
<!-- index.html -->

Origins

Metalsmith-mapsite is a fork of metalsmith-sitemap. After refactoring metalsmith-sitemap I decided I would like to keep the plugin as simple as possible, to minimize possible points of failure and because it already does a lot.

This conflicted with the maintainer's goals, which is why I forked the plugin to metalsmith-mapsite. Mainly just for personal use, but maybe it'll be of use for others as well!

License

MIT