{"id":23765805,"url":"https://github.com/solidusio-contrib/solidus_sitemap","last_synced_at":"2025-09-05T09:33:05.408Z","repository":{"id":47324814,"uuid":"55265645","full_name":"solidusio-contrib/solidus_sitemap","owner":"solidusio-contrib","description":"Provide a sitemap of your Solidus store.","archived":false,"fork":false,"pushed_at":"2024-08-01T20:02:34.000Z","size":138,"stargazers_count":13,"open_issues_count":2,"forks_count":27,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-12-20T14:33:04.075Z","etag":null,"topics":["crawlers","ecommerce","google","product","sitemap","solidus"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/solidusio-contrib.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-01T22:20:32.000Z","updated_at":"2024-01-04T18:34:11.000Z","dependencies_parsed_at":"2022-09-19T06:31:38.544Z","dependency_job_id":null,"html_url":"https://github.com/solidusio-contrib/solidus_sitemap","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_sitemap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_sitemap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_sitemap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_sitemap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/solidusio-contrib","download_url":"https://codeload.github.com/solidusio-contrib/solidus_sitemap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232034913,"owners_count":18463363,"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":["crawlers","ecommerce","google","product","sitemap","solidus"],"created_at":"2024-12-31T23:17:54.311Z","updated_at":"2024-12-31T23:17:54.901Z","avatar_url":"https://github.com/solidusio-contrib.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Solidus Sitemap\n\n[![Build Status](https://circleci.com/gh/solidusio-contrib/solidus_sitemap.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_sitemap)\n\nSolidus Sitemap is a sitemap generator based on the\n[sitemap_generator](https://github.com/kjvarga/sitemap_generator) gem. It adheres to the Sitemap\n0.9 protocol specification.\n\n## Capabilities\n\n- Adheres to the 0.9 Sitemap protocol specification\n- Notifies search engines of new sitemap versions\n- Supports large product catalogs\n- Compresses sitemaps with gzip\n- Allows you to easily add additional sitemaps for custom pages in your site\n- Supports Amazon S3 and other hosting services\n\n## Installation\n\nFirst of all, add the gem to your store's `Gemfile`:\n\n```ruby\ngem 'solidus_sitemap', github: 'solidusio-contrib/solidus_sitemap'\n```\n\nBundle your dependencies:\n\n```console\n$ bundle install\n```\n\nRun the installer, which will create a `config/sitemap.rb` file with some sane defaults:\n\n```console\n$ rails g solidus_sitemap:install\n```\n\nSet up a cron job to regenerate your sitemap via the `rake sitemap:refresh` task. If you use the\n[Whenever gem](https://github.com/javan/whenever), add this to your `config/schedule.rb`:\n\n```ruby\nevery 1.day, at: '5:00 am' do\n rake '-s sitemap:refresh'\nend\n```\n\nEnsure crawlers can find the sitemap by adding the following line to your `public/robots.txt` with\nyour own domain:\n\n```console\n$ echo \"Sitemap: http://www.example.com/sitemap.xml.gz\" \u003e\u003e public/robots.txt\n```\n\n## Upgrading\n\nIf you're upgrading from early versions of `solidus_sitemap`, you need to change your sitemaps from\nthis:\n\n```ruby\nSitemapGenerator::Sitemap.add_links do\n  # ...\nend\n```\n\nTo this:\n\n```ruby\nSitemapGenerator::Sitemap.create do\n  # ...\nend\n```\n\n## Configuration\n\nCheck out the [readme](https://github.com/kjvarga/sitemap_generator/blob/master/README.md) of the\n[sitemap_generator](https://github.com/kjvarga/sitemap_generator) gem.\n\n## Contributing\n\n### Releasing new versions\n\n#### 1. Bump gem version and push to RubyGems\n\nWe use [gem-release](https://github.com/svenfuchs/gem-release) to release this extension with ease.\n\nSupposing you are on the master branch and you are working on a fork of this extension, `upstream`\nis the main remote and you have write access to it, you can simply run:\n\n```bash\ngem bump --version minor --tag --release\n```\n\nThis command will:\n\n- bump the gem version to the next minor (changing the `version.rb` file)\n- commit the change and push it to upstream master\n- create a git tag\n- push the tag to the upstream remote\n- release the new version on RubyGems\n\nOr you can run these commands individually:\n\n```bash\ngem bump --version minor\ngem tag\ngem release\n```\n\n#### 2. Publish the updated CHANGELOG\n\nAfter the release is done we can generate the updated CHANGELOG using\n[github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator)\nby running the following command:\n\n```bash\nbundle exec github_changelog_generator solidusio/solidus_sitemap --token YOUR_GITHUB_TOKEN\ngit commit -am 'Update CHANGELOG'\ngit push upstream master\n```\n\n## Acknowledgements\n\n- [The original Spree version of this gem](https://github.com/spree-contrib/spree_sitemap)\n- [The creators \u0026 contributors of sitemap_generator](http://github.com/kjvarga/sitemap_generator/contributors)\n- [Joshua Nussbaum's original implementation of spree-sitemap-generator](https://github.com/joshnuss/spree-sitemap-generator)\n\n## License\n\n![Nebulab](http://nebulab.it/assets/images/public/logo.svg)\n\nCopyright (c) 2019 [Nebulab](https://nebulab.it).\n\nCopyright (c) 2016-2018 [Stembolt](https://stembolt.com/).\n\nCopyright (c) 2011-2015 [Jeff Dutil](https://github.com/jdutil) and\n[other contributors](https://github.com/solidusio-contrib/solidus_sitemap/graphs/contributors),\nreleased under the [New BSD License](https://github.com/kjvarga/sitemap_generator/blob/master/MIT-LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidusio-contrib%2Fsolidus_sitemap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolidusio-contrib%2Fsolidus_sitemap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidusio-contrib%2Fsolidus_sitemap/lists"}