jekyll-make-sitemap

A Jekyll hook plugin for generating a sitemap.txt file during the Jekyll build process. If you're interested in generating an XML sitemap I recommend checking out jekyll-sitemap.

This plugin includes all pages and posts by default. See the Configuration section for more on configuring your sitemap.

Installation

gem install jekyll-make-sitemap

Set Up

In Gemfile

...
group :jekyll_plugins do
  ...
  gem 'jekyll-make-sitemap'
end

Configuration

In _config.yml

jekyll-make-sitemap:
  pages: true       # Default: true
  posts:            # Default: true
   - category       # Categories of posts to include in sitemap; accepts true, false, or a list of categories
  environments:     # Default: ['production']
   - production 
   - development
  collections:      # Default: []
   - collection_1   # include items from collection_1 in sitemap

Exceptions

To exclude a page or post, assign it the sitemap-exclude tag

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the jekyll-make-sitemap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.