Skip to content
This repository has been archived by the owner. It is now read-only.
A Wintersmith plugin to generate a sitemap.xml file
JavaScript HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples/basic
lib
test
.editorconfig
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
LICENSE.txt
README.md
package-lock.json
package.json

README.md

wintersmith-sitemap Build Status

A Wintersmith plugin to generate a sitemap.xml file

Installation

Install globally or locally using npm:

npm install [-g] wintersmith-sitemap wintersmith-contents

Add wintersmith-sitemap and wintersmith-contents to your config.json:

{
  "plugins": [
    "wintersmith-contents",
    "wintersmith-sitemap"
  ]
}

Define the url property in the locals property:

{
  "locals": {
    "url": "http://example.com"
  }
}

Usage

wintersmith-sitemap extracts all Markdown pages from the content tree and lists them into the sitemap. By default, the sitemap only contains the location of all pages. If you need to include more information like the last modification date, the change frequency, or the priority, you need to define this information in the metadata:

---
title: Hello, world!
date: 2014-10-31 23:59:59
changefreq: weekly
priority: 0.8
template: entry.jade
---

If you want to exclude a page from the sitemap, you need to define noindex: true in the metadata:

---
title: Hello, world!
date: 2014-10-31 23:59:59
template: entry.jade
noindex: true
---

License

wintersmith-sitemap is released under the MIT license.

You can’t perform that action at this time.