{"id":13612378,"url":"https://github.com/jekyll/jekyll-sitemap","last_synced_at":"2025-05-14T03:11:55.166Z","repository":{"id":14610280,"uuid":"17327535","full_name":"jekyll/jekyll-sitemap","owner":"jekyll","description":"Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site","archived":false,"fork":false,"pushed_at":"2024-08-08T22:28:41.000Z","size":314,"stargazers_count":978,"open_issues_count":16,"forks_count":141,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-05-07T00:06:21.968Z","etag":null,"topics":["jekyll-plugin","ruby","sitemap"],"latest_commit_sha":null,"homepage":"http://rubygems.org/gems/jekyll-sitemap","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jekyll.png","metadata":{"files":{"readme":"README.md","changelog":"History.markdown","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-03-02T00:17:43.000Z","updated_at":"2025-05-01T14:21:39.000Z","dependencies_parsed_at":"2024-08-10T15:14:45.518Z","dependency_job_id":null,"html_url":"https://github.com/jekyll/jekyll-sitemap","commit_stats":{"total_commits":277,"total_committers":39,"mean_commits":7.102564102564102,"dds":0.7256317689530686,"last_synced_commit":"99148a2255a2b3a8d2b31ba8216945262981b12c"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jekyll%2Fjekyll-sitemap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jekyll%2Fjekyll-sitemap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jekyll%2Fjekyll-sitemap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jekyll%2Fjekyll-sitemap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jekyll","download_url":"https://codeload.github.com/jekyll/jekyll-sitemap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254059520,"owners_count":22007771,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jekyll-plugin","ruby","sitemap"],"created_at":"2024-08-01T20:00:28.971Z","updated_at":"2025-05-14T03:11:50.158Z","avatar_url":"https://github.com/jekyll.png","language":"Ruby","funding_links":[],"categories":["Search Engine Optimization (SEO) \u0026 Redirects","Ruby","Plugins"],"sub_categories":[],"readme":"# Jekyll Sitemap Generator Plugin\n\n*Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site*\n\n[![Build Status](https://travis-ci.org/jekyll/jekyll-sitemap.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-sitemap)\n\n## Usage\n\n1. Add `gem 'jekyll-sitemap'` to your site's Gemfile and run `bundle`\n2. Add the following to your site's `_config.yml`:\n\n```yml\nurl: \"https://example.com\" # the base hostname \u0026 protocol for your site\nplugins:\n  - jekyll-sitemap\n```\n\n💡 If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.\n\nIf all gem plugins have the same `priority`, they will be executed in the\norder they are required, generally. Thus, if you have other plugins which\ngenerate content and store that content in `site.pages`, `site.posts`, or\n`site.collections`, be sure to require `jekyll-sitemap` either *after*\nthose other gems if you *want* the sitemap to include the generated\ncontent, or *before* those other gems if you *don't want* the sitemap to\ninclude the generated content from the gems. (Programming is *hard*.)\n\nBecause the sitemap is added to `site.pages`, you may have to modify any\ntemplates that iterate through all pages (for example, to build a menu of\nall of the site's content).\n\n## Note on Use with GitHub Pages Gem\nThe 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`.\n\nWhen 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`.\n\n:warning: If you are using Jekyll \u003c 3.5.0 use the `gems` key instead of `plugins`.\n\n## `\u003clastmod\u003e` tag\nThe `\u003clastmod\u003e` tag in the `sitemap.xml` will reflect by priority:\n\n1.   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)\n2.   A personalised date if you add the variable `last_modified_at:` with a date in the Front Matter\n3.   The creation date of your post (corresponding to the `post.date` variable)\n\n## Exclusions\n\nIf you would like to exclude specific pages/posts from the sitemap set the\nsitemap flag to `false` in the front matter for the page/post.\n\n```yml\nsitemap: false\n```\n\nTo 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).\n\nAdd a glob config to your `_config.yml` file. \n\n```yml\ndefaults:\n  -\n    scope:\n      path:            \"assets/**/*.pdf\"\n    values:\n      sitemap:         false\n```\n\n## Override default development settings\n\n[Follow these instructions on Jekyll's documentation](https://jekyllrb.com/docs/usage/#override-default-development-settings).\n\n## Developing locally\n\n* Use `script/bootstrap` to bootstrap your local development environment.\n* Use `script/console` to load a local IRB console with the Gem.\n\n## Testing\n\n1. `script/bootstrap`\n2. `script/cibuild`\n\n## Known Issues\n\n1. 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.\n2. 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.\n\n## Contributing\n\n1. Fork the project\n2. Create a descriptively named feature branch\n3. Add your feature\n4. Submit a pull request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjekyll%2Fjekyll-sitemap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjekyll%2Fjekyll-sitemap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjekyll%2Fjekyll-sitemap/lists"}