Jekyll Sitemap Generator Plugin
Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site
Usage
- Add
gem 'jekyll-sitemap'to your site's Gemfile and runbundle - Add the following to your site's
_config.yml:
url: "https://example.com" # the base hostname & protocol for your site
plugins:
- jekyll-sitemap
💡 If you are using a Jekyll version less than 3.5.0, use the gems key instead of plugins.
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).
Note on Use with GitHub Pages Gem
The GitHub Pages gem ignores all plugins included in the Gemfile. If you only include jekyll-sitemap in the Gemfile without also including it in the _config.yml the plugin will not work. This can be confusing because the official Jekyll docs state that plugins can be included in either the Gemfile or _config.yml.
When building a site that uses the GitHub Pages gem, follow the instructions above and ensure that jekyll-sitemap is listed in the plugins array in _config.yml.
:warning: If you are using Jekyll < 3.5.0 use the gems key instead of plugins.
<lastmod> tag
The <lastmod> tag in the sitemap.xml will reflect by priority:
- The modified date of the file as reported by the filesystem if you have
jekyll-last-modified-atplugin installed (not compatible with GitHub Pages auto building) - A personalised date if you add the variable
last_modified_at:with a date in the Front Matter - The creation date of your post (corresponding to the
post.datevariable)
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
To exclude files from your sitemap. It can be achieved with configuration using Jekyll v3.7.2 and jekyll-sitemap v1.2.0.
Add a glob config to your _config.yml file.
defaults:
-
scope:
path: "assets/**/*.pdf"
values:
sitemap: false
Override default development settings
Follow these instructions on Jekyll's documentation.
Developing locally
- Use
script/bootstrapto bootstrap your local development environment. - Use
script/consoleto load a local IRB console with the Gem.
Testing
script/bootstrapscript/cibuild
Known Issues
- If the
sitemap.xmldoesn't generate in the_sitefolder, ensure_config.ymldoesn't havesafe: true. That prevents all plugins from working. - If the
sitemap.xmldoesn't generate in the_sitefolder, ensure that you don't have a sitemap generator plugin in your_pluginfolder.
Contributing
- Fork the project
- Create a descriptively named feature branch
- Add your feature
- Submit a pull request