Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jekyll/jekyll-sitemap
Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site
https://github.com/jekyll/jekyll-sitemap
jekyll-plugin ruby sitemap
Last synced: 5 days ago
JSON representation
Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site
- Host: GitHub
- URL: https://github.com/jekyll/jekyll-sitemap
- Owner: jekyll
- License: mit
- Created: 2014-03-02T00:17:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-08-08T22:28:41.000Z (3 months ago)
- Last Synced: 2024-10-22T02:37:56.704Z (13 days ago)
- Topics: jekyll-plugin, ruby, sitemap
- Language: Ruby
- Homepage: http://rubygems.org/gems/jekyll-sitemap
- Size: 307 KB
- Stars: 966
- Watchers: 19
- Forks: 136
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: History.markdown
- License: LICENSE.md
Awesome Lists containing this project
- awesome-jekyll-plugins - **Sitemap Generator** - sitemap](https://rubygems.org/gems/jekyll-sitemap)) -- a plugin to silently generate a sitemaps.org compliant sitemap for your site **#Official** **#GitHub Pages** (Search Engine Optimization (SEO) & Redirects)
README
# Jekyll Sitemap Generator Plugin
*Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site*
[](https://travis-ci.org/jekyll/jekyll-sitemap)
## Usage
1. Add `gem 'jekyll-sitemap'` to your site's Gemfile and run `bundle`
2. Add the following to your site's `_config.yml`:
```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`.
## `` tag
The `` 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 personalised date if you add the variable `last_modified_at:` with a date in the Front Matter
3. The creation date of your post (corresponding 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.
```yml
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](https://github.com/jekyll/jekyll/commit/776433109b96cb644938ffbf9caf4923bdde4d7f).
Add a glob config to your `_config.yml` file.
```yml
defaults:
-
scope:
path: "assets/**/*.pdf"
values:
sitemap: false
```
## Override default development settings
[Follow these instructions on Jekyll's documentation](https://jekyllrb.com/docs/usage/#override-default-development-settings).
## 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