{"id":16737330,"url":"https://github.com/yasaichi/gretel-jsonld","last_synced_at":"2025-10-08T17:13:38.552Z","repository":{"id":46541230,"uuid":"111183603","full_name":"yasaichi/gretel-jsonld","owner":"yasaichi","description":"Gretel extension for supporting JSON-LD breadcrumbs :bread:","archived":false,"fork":false,"pushed_at":"2023-12-15T08:22:37.000Z","size":58,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-02T20:20:53.585Z","etag":null,"topics":["breadcrumbs","json-ld","rails"],"latest_commit_sha":null,"homepage":"","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/yasaichi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"MIT-LICENSE","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":"2017-11-18T06:47:51.000Z","updated_at":"2023-03-10T09:33:35.000Z","dependencies_parsed_at":"2024-10-13T00:25:56.118Z","dependency_job_id":"5c67ffa7-97a8-4ab9-9985-5bbd97eb60c1","html_url":"https://github.com/yasaichi/gretel-jsonld","commit_stats":{"total_commits":44,"total_committers":1,"mean_commits":44.0,"dds":0.0,"last_synced_commit":"fd00d2e63c3dd7142a6d52269fbfee9d2aa856cc"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/yasaichi/gretel-jsonld","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yasaichi%2Fgretel-jsonld","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yasaichi%2Fgretel-jsonld/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yasaichi%2Fgretel-jsonld/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yasaichi%2Fgretel-jsonld/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yasaichi","download_url":"https://codeload.github.com/yasaichi/gretel-jsonld/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yasaichi%2Fgretel-jsonld/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278981518,"owners_count":26079640,"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","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["breadcrumbs","json-ld","rails"],"created_at":"2024-10-13T00:25:53.958Z","updated_at":"2025-10-08T17:13:38.531Z","avatar_url":"https://github.com/yasaichi.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gretel-jsonld\n\n[![Gem Version](https://badge.fury.io/rb/gretel-jsonld.svg)](http://badge.fury.io/rb/gretel-jsonld)\n[![Build Status](https://travis-ci.org/yasaichi/gretel-jsonld.svg?branch=master)](https://travis-ci.org/yasaichi/gretel-jsonld)\n[![Code Climate](https://api.codeclimate.com/v1/badges/fc3fd5037eb200bedbf5/maintainability)](https://codeclimate.com/github/yasaichi/gretel-jsonld/maintainability)\n[![Test Coverage](https://codeclimate.com/github/yasaichi/gretel-jsonld/badges/coverage.svg)](https://codeclimate.com/github/yasaichi/gretel-jsonld/coverage)\n\ngretel-jsonld enables gretel gem to handle JSON-LD based breadcrumbs.\n\n## Installation\n\nAdd this line to your application's `Gemfile`:\n\n```ruby\ngem 'gretel-jsonld'\n```\n\nAnd then execute:\n\n```bash\n$ bundle\n```\n\n## Usage\n\nFirst, run the installation generator with:\n\n```sh\n$ rails generate gretel:install\n```\n\nNext, define \"crumbs\" in `config/breadcrumbs.rb`:\n\n```ruby\n# See also: https://github.com/lassebunk/gretel#more-examples\n\n# Root crumb\ncrumb :root do\n  link 'Home', root_path\nend\n\n# Issue list\ncrumb :issues do\n  link 'All issues', issues_path\nend\n\n# Issue\ncrumb :issue do |issue|\n  link issue.title, issue\n  parent :issues\nend\n```\n\nThen, add this line to your application's layout:\n\n```erb\n\u003c%= jsonld_breadcrumbs %\u003e\n```\n\nFinally, specify a current breadcrumb in each view:\n\n```erb\n\u003c% breadcrumb :issue, @issue %\u003e\n```\n\nThis will generate the following breadcrumbs, marked up with JSON-LD (indented for readability):\n\n```html\n\u003cscript type=\"application/ld+json\"\u003e\n  {\n    \"@context\": \"http://schema.org\",\n    \"@type\": \"BreadcrumbList\",\n    \"itemListElement\": [\n      {\n        \"@type\": \"ListItem\",\n        \"position\": 1,\n        \"item\": {\n          \"@id\": \"/\",\n          \"name\": \"Home\"\n        }\n      },\n      {\n        \"@type\": \"ListItem\",\n        \"position\": 2,\n        \"item\": {\n          \"@id\": \"/issues\",\n          \"name\": \"All issues\"\n        }\n      },\n      {\n        \"@type\": \"ListItem\",\n        \"position\": 3,\n        \"item\": {\n          \"@id\": \"/issues/46\",\n          \"name\": \"My Issue\"\n        }\n      }\n    ]\n  }\n\u003c/script\u003e\n```\n\n## Options\n\nYou can pass `jsonld_breadcrumbs` the same options as `breadcrumbs`:\n\n```erb\n\u003c%= jsonld_breadcrumbs link_current_to_request_path: false %\u003e\n```\n\nFor further information, please see [gretel's documentation](https://github.com/WilHall/gretel/blob/develop/README.md#options).\n\n## Supported versions\n\nNote that gretel-jsonld doesn't support all versions of gretel, Ruby and Rails:\n\n- gretel: gretel-jsonld supports **only 3.x** for now\n- Ruby: gretel 3.x supports **1.9.3 or later**, but gretel-jsonld does **only 2.2.2 or later**\n- Rails: gretel 3.x supports **3.1 or later**, but gretel-jsonld does **only 3.2 or later**\n\n## Contributing\n\nYou should follow the steps below:\n\n1. [Fork the repository](https://help.github.com/articles/fork-a-repo/)\n2. Create a feature branch: `git checkout -b add-new-feature`\n3. Commit your changes: `git commit -am 'Add new feature'`\n4. Push the branch: `git push origin add-new-feature`\n5. [Send us a pull request](https://help.github.com/articles/about-pull-requests/)\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyasaichi%2Fgretel-jsonld","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyasaichi%2Fgretel-jsonld","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyasaichi%2Fgretel-jsonld/lists"}