https://github.com/ukstudio/structured-data

https://github.com/ukstudio/structured-data

json-ld seo

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/ukstudio/structured-data
• Owner: ukstudio
• License: mit
• Created: 2016-12-19T13:18:40.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-04-27T15:21:24.000Z (over 7 years ago)
• Last Synced: 2024-04-29T05:23:22.207Z (7 months ago)
• Topics: json-ld, seo
• Language: Ruby
• Size: 13.7 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# StructuredData

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'structured-data'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install structured-data

## Usage

```ruby

repo = StructuredData::Repository.new

breadcrumb = StructuredData::BreadcrumbList.new

breadcrumb << { url: '/products', name: 'Products' }

breadcrumb << { url: '/products/book', name: 'Book' }

repo << breadcrumb

repo.dump

```

```json

[{

  "@context": "http://schema.org",

  "@type": "BreadcrumbList",

  "itemListElement": [

    {

      "@type": "ListItem",

      "position": 1,

      "item": {

        "@id": "/products",

        "name": "Products"

      }

    },

    {

      "@type": "ListItem",

      "position": 2,

      "item": {

        "@id": "/products/book",

        "name": "Book"

      }

    }

  ]

}]

```

### Rails support

```ruby

# in controller or view

breadcrumb_list do

  add url: '/products', name: 'Product'

  add url: '/products/tshirts, name: 'Tshirt'

end

```

```slim

= display_structured_data

```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ukstudio/structured_data.