Jekyll Sitemap Generator Plugin

Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site

Usage

1. Add gem 'jekyll-sitemap' to your site's Gemfile and run bundle
2. Add the following to your site's _config.yml:

gems:
  - jekyll-sitemap

# optionally, to include more static files

sitemap:
  extensions:
    - .ps

If all gem plugins have the same priority, they will be executed in the order they are required, generally. Thus, if you have other plugins which generate content and store that content in site.pages, site.posts, or site.collections, be sure to require jekyll-sitemap either after those other gems if you want the sitemap to include the generated content, or before those other gems if you don't want the sitemap to include the generated content from the gems. (Programming is hard.)

Because the sitemap is added to site.pages, you may have to modify any templates that iterate through all pages (for example, to build a menu of all of the site's content).

<lastmod> tag

The <lastmod> tag in the sitemap.xml will reflect by priority:

1. The modified date of the file as reported by the filesystem if you have jekyll-last-modified-at plugin installed (not compatible with Github Pages auto building)
2. A personnalised date if you add the variable last_modified_at: with a date in the Front Matter
3. The creation date of your post (correspondig to the post.date variable)

Exclusions

If you would like to exclude specific pages/posts from the sitemap set the sitemap flag to false in the front matter for the page/post.

sitemap: false

Developing locally

Use script/bootstrap to bootstrap your local development environment.

Use script/console to load a local IRB console with the Gem.

Testing

1. script/bootstrap
2. script/cibuild

Known Issues

1. If the sitemap.xml doesn't generate in the _site folder, ensure _config.yml doesn't have safe: true. That prevents all plugins from working.
2. If the sitemap.xml doesn't generate in the _site folder, ensure that you don't have a sitemap generator plugin in your _plugin folder.

Contributing

1. Fork the project
2. Create a descriptively named feature branch
3. Add your feature
4. Submit a pull request