Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kpumuk/meta-tags

Search Engine Optimization (SEO) for Ruby on Rails applications.
https://github.com/kpumuk/meta-tags

meta-tags opengraph opengraph-tags rails ruby search-engine-optimization seo seo-meta seotools twitter-cards webmasters

Last synced: 3 days ago
JSON representation

Search Engine Optimization (SEO) for Ruby on Rails applications.

Host: GitHub
URL: https://github.com/kpumuk/meta-tags
Owner: kpumuk
License: mit
Created: 2008-09-17T01:41:59.000Z (about 16 years ago)
Default Branch: main
Last Pushed: 2024-10-28T14:00:01.000Z (11 days ago)
Last Synced: 2024-11-04T13:44:56.445Z (4 days ago)
Topics: meta-tags, opengraph, opengraph-tags, rails, ruby, search-engine-optimization, seo, seo-meta, seotools, twitter-cards, webmasters
Language: Ruby
Homepage:
Size: 917 KB
Stars: 2,733
Watchers: 49
Forks: 275
Open Issues: 15
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: MIT-LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

my-awesome-rails-gem - meta-tags - Search Engine Optimization (SEO) plugin for Ruby on Rails applications. (View Helper / Omniauth)
awesome-ruby - MetaTags - A gem to make your Rails application SEO-friendly. (SEO)
awesome-rails-gem - meta-tags - Search Engine Optimization (SEO) plugin for Ruby on Rails applications. (View Helper / Omniauth)

README

# MetaTags: a gem to make your Rails application SEO-friendly

[![Tests](https://github.com/kpumuk/meta-tags/actions/workflows/tests.yml/badge.svg)](https://github.com/kpumuk/meta-tags/actions/workflows/tests.yml)
[![Gem Version](https://badge.fury.io/rb/meta-tags.svg)](https://badge.fury.io/rb/meta-tags)
[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
[![Code Climate](https://codeclimate.com/github/kpumuk/meta-tags/badges/gpa.svg)](https://codeclimate.com/github/kpumuk/meta-tags)
[![Test Coverage](https://codeclimate.com/github/kpumuk/meta-tags/badges/coverage.svg)](https://codeclimate.com/github/kpumuk/meta-tags/coverage)
[![Gem Downloads](https://img.shields.io/gem/dt/meta-tags.svg)](https://badge.fury.io/rb/meta-tags)
[![Changelog](https://img.shields.io/badge/Changelog-latest-blue.svg)](https://github.com/kpumuk/meta-tags/blob/main/CHANGELOG.md)

Search Engine Optimization (SEO) plugin for Ruby on Rails applications.

## Ruby on Rails

The MetaTags main branch fully supports Ruby on Rails 6.1+ and is tested against all major Ruby on Rails releases.

> [!NOTE]
> We no longer support Ruby versions older than 3.0 and Ruby on Rails older than 6.1 since they reached their end of life (see [Ruby](https://endoflife.date/ruby) and [Ruby on Rails](https://endoflife.date/rails)).

## Installation

Add the "meta-tags" gem to your `Gemfile`.

```ruby
gem "meta-tags"
```

And run `bundle install` command.

## Configuration

MetaTags follows best practices for meta tags. Although default limits for truncation have recommended values, you can change them to reflect your own preferences. Keywords are converted to lowercase by default, but this is also configurable.

To override the defaults, create an initializer `config/initializers/meta_tags.rb` using the following command:

```bash
rails generate meta_tags:install
```

By default, meta tags are rendered with the key `name`. However, some meta tags are required to use `property` instead (like Facebook Open Graph object). The MetaTags gem allows you to configure which tags to render with the `property` attribute. The pre-configured list includes all possible Facebook Open Graph object types by default, but you can add your own in case you need it.

## MetaTags Usage

First, add this code to your main layout:

```erb

<%= display_meta_tags site: "My website" %>

```

Then, to set the page title, add this to each of your views (see below for other options):

```erb

<%= title "My page title" %>

```

When views are rendered, the page title will be included in the right spots:

```html

My website | My page title

My page title

```

You can find allowed options for the `display_meta_tags` method below.

> [!IMPORTANT]
> You **must** use `display_meta_tags` in the layout files to render the meta tags. In the views, you will instead use `set_meta_tags`, which accepts the same arguments but does not render anything in the place where it is called.

### Using MetaTags in controller

You can define the following instance variables:

```ruby
@page_title = "Member Login"
@page_description = "Member login page."
@page_keywords = "Site, Login, Members"
```

Also, you could use the `set_meta_tags` method to define all meta tags simultaneously:

```ruby
set_meta_tags(
title: "Member Login",
description: "Member login page.",
keywords: "Site, Login, Members"
)
```

You can find the allowed options for the `set_meta_tags` method below.

### Using MetaTags in view

To set meta tags, you can use the following methods:

```erb
<% title "Member Login" %>
<% description "Member login page." %>
<% keywords "Site, Login, Members" %>
<% nofollow %>
<% noindex %>
<% refresh 3 %>
```

Also, the `set_meta_tags` method exists:

```erb
<%
set_meta_tags(
title: "Member Login",
description: "Member login page.",
keywords: "Site, Login, Members"
)
%>
```

You can pass an object that implements the `#to_meta_tags` method and returns a Hash:

```ruby
class Document < ApplicationRecord
def to_meta_tags
{
title: title,
description: summary
}
end
end

@document = Document.first
set_meta_tags @document
```

The `title` method returns the title itself, so you can use it to show the title
somewhere on the page:

```erb

<%= title "Member Login" %>

```

If you want to set the title and display another text, use this:

```erb

<%= title "Member Login", "Here you can login to the site:" %>

```

### Allowed options for `display_meta_tags` and `set_meta_tags` methods

Use these options to customize the title format:

| Option | Description |
| -------------- | ------------------------------------------------------------------------------------------------------------------- |
| `:site` | Site title |
| `:title` | Page title |
| `:description` | Page description |
| `:keywords` | Page keywords |
| `:charset` | Page character set |
| `:prefix` | Text between site name and separator |
| `:separator` | Text used to separate the website name from the page title |
| `:suffix` | Text between separator and page title |
| `:lowercase` | When true, the page name will be lowercase |
| `:reverse` | When true, the page and site names will be reversed |
| `:noindex` | Add noindex meta tag; when true, "robots" will be used; accepts a string with a robot name or an array of strings |
| `:index` | Add index meta tag; when true, "robots" will be used; accepts a string with a robot name or an array of strings |
| `:nofollow` | Add nofollow meta tag; when true, "robots" will be used; accepts a string with a robot name or an array of strings |
| `:follow` | Add follow meta tag; when true, "robots" will be used; accepts a string with a robot name or an array of strings |
| `:noarchive` | Add noarchive meta tag; when true, "robots" will be used; accepts a string with a robot name or an array of strings |
| `:canonical` | Add canonical link tag |
| `:prev` | Add prev link tag |
| `:next` | Add next link tag |
| `:image_src` | Add image_src link tag |
| `:og` | Add Open Graph tags (Hash) |
| `:twitter` | Add Twitter tags (Hash) |
| `:refresh` | Refresh interval and optionally URL to redirect to |

And here are a few examples to give you ideas.

```erb
<%= display_meta_tags separator: "—".html_safe %>
<%= display_meta_tags prefix: false, separator: ":" %>
<%= display_meta_tags lowercase: true %>
<%= display_meta_tags reverse: true, prefix: false %>
<%= display_meta_tags og: { title: "The Rock", type: "video.movie" } %>
<%= display_meta_tags alternate: { "zh-Hant" => "http://example.com.tw/base/url" } %>
```

### Allowed values

You can specify `:title` as a string or array:

```ruby
set_meta_tags title: ["part1", "part2"], site: "site"
# site | part1 | part2
set_meta_tags title: ["part1", "part2"], reverse: true, site: "site"
# part2 | part1 | site
```

Keywords can be passed as a string of comma-separated values or as an array:

```ruby
set_meta_tags keywords: ["tag1", "tag2"]
# tag1, tag2
```

The description is a string (HTML will be stripped from the output string).

### Mirrored values

Sometimes, it is desirable to mirror meta tag values down into namespaces. A common use case is when you want the open graph's `og:title` to be identical to the `title`.

Let's say you have the following code in your application layout:

```ruby
display_meta_tags og: {
title: :title,
site_name: :site
}
```

The value of `og[:title]` is a symbol, which refers to the value of the top-level `title` meta tag. In any view with the following code:

```ruby
title "my great view"
```

You will get this open graph meta tag automatically:

```html

```

> [!NOTE]
> The `title` does not include the site name. If you need to reference the exact value rendered in the `` meta tag, use `:full_title`.

### Using with Turbo

[Turbo](https://github.com/hotwired/turbo) is a simple solution for getting the performance benefits of a single-page application without the added complexity of a client-side JavaScript framework. MetaTags supports Turbo out of the box, so no configuration is necessary.

In order to update the page title, you can use the following trick. First, set the ID for the `` HTML tag using MetaTags configuration in your initializer `config/initializers/meta_tags.rb`:

```ruby
MetaTags.configure do |config|
config.title_tag_attributes = {id: "page-title"}
end
```

Now in your turbo frame, you can update the title using a turbo stream:

```html

My new title

```

### Using with pjax

[jQuery.pjax](https://github.com/defunkt/jquery-pjax) is a nice solution for navigation without a full-page reload. The main difference is that the layout file will not be rendered, so the page title will not change. To fix this, when using a page fragment, pjax will check the fragment DOM element for a `title` or `data-title` attribute and use any value it finds.

MetaTags simplifies this with the `display_title` method, which returns the fully resolved page title (including site, prefix/suffix, etc.). But in this case, you will have to set default parameters (e.g., `:site`) both in the layout file and in your views. To minimize code duplication, you can define a helper in `application_helper.rb`:

```ruby
def default_meta_tags
{
title: "Member Login",
description: "Member login page.",
keywords: "Site, Login, Members",
separator: "—".html_safe
}
end
```

Then, in your layout file, use:

```erb
<%= display_meta_tags(default_meta_tags) %>
```

And in your pjax templates:

```erb

<% title "My Page title" %>
<%= content_tag :div, data: { title: display_title(default_meta_tags) } do %>

<%= title %>

<% end %>
```

## SEO Basics and MetaTags

### Titles

Page titles are very important for search engines. The titles in the browser are displayed in the title bar. Search engines look at the title bar to determine what the page is all about.

```ruby
set_meta_tags title: "Member Login"
# Member Login
set_meta_tags site: "Site Title", title: "Member Login"
# Site Title | Member Login
set_meta_tags site: "Site Title", title: "Member Login", reverse: true
# Member Login | Site Title
```

Recommended title tag length: up to **70 characters** in **10 words**.

Further reading:

- [Title Tag](https://moz.com/learn/seo/title-tag)

### Description

Description meta tags are not displayed by browsers, unlike titles. However, some search engines may choose to display them. These tags are utilized to provide a concise summary of a webpage's content, typically within 2 or 3 sentences.

Below is an example of how to set a description tag using Ruby:

```ruby
set_meta_tags description: "This is a sample description"
#
```

It is advisable to limit the length of the description tag to **300 characters**.

Further reading:

- [Meta Description](https://moz.com/learn/seo/meta-description)
- [How Long Should Your Meta Description Be? (2018 Edition)](https://moz.com/blog/how-long-should-your-meta-description-be-2018)

### Keywords

Meta keywords tags are used to place keywords that you believe users would search for in search engines. It is important to avoid unnecessary repetition of keywords, as this could be considered spam and may result in a permanent ban from search engine results pages (SERPs).

```ruby
set_meta_tags keywords: %w[keyword1 keyword2 keyword3]
#
```

It is recommended to keep the length of the keywords tag under **255 characters** or **20 words**.

> [!NOTE]
> Both Google and Bing have publicly stated that they completely ignore keywords meta tags.

### Noindex

By using the noindex meta tag, you can signal to search engines not to include specific pages in their indexes.

```ruby
set_meta_tags noindex: true
#
set_meta_tags noindex: "googlebot"
#
```

This is useful for pages like login, password reset, privacy policy, etc.

Further reading:

- [Blocking Google](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=93708)
- [Using meta tags to block access to your site](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=93710)

### Index

Although it is not required to add "index" to "robots" as it is the default value for Google, some SEO specialists recommend adding it to the website.

```ruby
set_meta_tags index: true
#
```

### Nofollow

Nofollow meta tags tell a search engine not to follow the links on a specific page. It is entirely possible that a robot might find the same links on another page without a nofollow attribute, perhaps on another site, and still arrive at your undesired page.

```ruby
set_meta_tags nofollow: true
#
set_meta_tags nofollow: "googlebot"
#
```

Further reading:

- [About rel="nofollow"](http://www.google.com/support/webmasters/bin/answer.py?answer=96569)
- [Meta tags](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=79812)

### Follow

You can use the Noindex meta tag in conjunction with Follow.

```ruby
set_meta_tags noindex: true, follow: true
#
```

This tag will prevent search engines from indexing this specific page, but it will still allow them to crawl and index the remaining pages on your website.

### Canonical URL

Canonical link elements tell search engines what the canonical or main URL is for content that has multiple URLs. The search engine will always return that URL, and link popularity and authority will be applied to that URL.

> [!NOTE]
> If you follow John Mueller's suggestion not to mix canonical with noindex, then you can set `MetaTags.config.skip_canonical_links_on_noindex = true` and we'll handle it for you.

```ruby
set_meta_tags canonical: "http://yoursite.com/canonical/url"
#
```

Further reading:

- [About rel="canonical"](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=139394)
- [Canonicalization](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=139066)

### Icon

A favicon (short for Favorite icon), also known as a shortcut icon, website icon, tab icon, or bookmark icon, is a file containing one or more small icons, most commonly 16x16 pixels, associated with a particular website or web page.

```ruby
set_meta_tags icon: "/favicon.ico"
#
set_meta_tags icon: "/favicon.png", type: "image/png"
#
set_meta_tags icon: [
{href: "/images/icons/icon_96.png", sizes: "32x32 96x96", type: "image/png"},
{href: "/images/icons/icon_itouch_precomp_32.png", rel: "apple-touch-icon-precomposed", sizes: "32x32", type: "image/png"}
]
#
#
```

Further reading:

- [Favicon](https://www.wikiwand.com/en/Favicon)
- [Touch Icons](https://mathiasbynens.be/notes/touch-icons)

### Multi-regional and multilingual URLs, RSS and mobile links

Alternate link elements tell a search engine when there is content that's translated or targeted to users in a certain region.

```ruby
set_meta_tags alternate: {"fr" => "http://yoursite.fr/alternate/url"}
#

set_meta_tags alternate: {"fr" => "http://yoursite.fr/alternate/url",
"de" => "http://yoursite.de/alternate/url"}
#
#
```

If you need more than just multi-lingual links, you can use an alternative syntax:

```ruby
set_meta_tags alternate: [
{href: "http://example.fr/base/url", hreflang: "fr"},
{href: "http://example.com/feed.rss", type: "application/rss+xml", title: "RSS"},
{href: "http://m.example.com/page-1", media: "only screen and (max-width: 640px)"}
]
```

Further reading:

- [Multi-regional and multilingual sites](https://support.google.com/webmasters/answer/182192)
- [About rel="alternate" hreflang="x"](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=189077)
- [Separate URLs](https://developers.google.com/webmasters/mobile-sites/mobile-seo/configurations/separate-urls#annotation-in-the-html)

### Pagination links

Previous and next links indicate the relationship between individual URLs. Using these attributes is a strong hint to Google that you want us to treat these pages as a logical sequence.

```ruby
set_meta_tags prev: "http://yoursite.com/url?page=1"
#
set_meta_tags next: "http://yoursite.com/url?page=3"
#
```

Further reading:

- [Pagination](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=1663744)
- [Pagination with rel="next" and rel="prev"](http://googlewebmastercentral.blogspot.ca/2011/09/pagination-with-relnext-and-relprev.html)

### image_src links

Basically, when you submit/share this to Facebook, it helps Facebook determine which image to put next to the link. If this is not present, Facebook tries to put in the first image it finds on the page, which may not be the best one to represent your site.

```ruby
set_meta_tags image_src: "http://yoursite.com/icons/icon_32.png"
#
```

### amphtml links

AMP is a method of building web pages for static content that renders quickly. If you have two versions of a page - non-AMP and AMP - you can link the AMP version from the normal one using the `amphtml` tag:

```ruby
set_meta_tags amphtml: url_for(format: :amp, only_path: false)
#
```

To link back to the normal version, use the `canonical` tag.

- [What Is AMP?](https://www.ampproject.org/learn/about-amp/)
- [Make Your Page Discoverable](https://www.ampproject.org/docs/guides/discovery)

### Manifest links

By including the `rel="manifest"` attribute in the `` element of an HTML page, you can specify the location of the manifest file that describes the web application. This allows the browser to understand that the web page is an application and to provide features like offline access and the ability to add the application to the home screen of a mobile device.

```ruby
set_meta_tags manifest: "manifest.json"
#
```

- [What is manifest?](https://developer.mozilla.org/en-US/docs/Web/Manifest)

### Refresh interval and redirect URL

Meta refresh is a method of instructing a web browser to automatically refresh the current web page or frame after a given time interval. It is also possible to instruct the browser to fetch a different URL when the page is refreshed, by including the alternative URL in the content parameter. By setting the refresh time interval to zero (or a very low value), this allows meta refresh to be used as a method of URL redirection.

```ruby
set_meta_tags refresh: 5
#
set_meta_tags refresh: "5;url=http://example.com"
#
```

Further reading:

- [Meta refresh](http://en.wikipedia.org/wiki/Meta_refresh)
- [What is the Meta Refresh Tag](http://webdesign.about.com/od/metataglibraries/a/aa080300a.htm)

### Open Search

Open Search is a link element used to describe a search engine in a standard and accessible format.

```ruby
set_meta_tags open_search: {
title: "Open Search",
href: "/opensearch.xml"
}
#
```

Further reading:

- [OpenSearch specs](http://www.opensearch.org/Specifications/OpenSearch/1.1)
- [OpenSearch wiki](http://en.wikipedia.org/wiki/OpenSearch)

### Hashes

Any namespace can be created by simply passing a symbol name and a Hash. For example:

```ruby
set_meta_tags foo: {
bar: "lorem",
baz: {
qux: "ipsum"
}
}
#
#
```

### Arrays

Repeated meta tags can be easily created by using an Array within a Hash. For example:

```ruby
set_meta_tags og: {
image: ["http://example.com/rock.jpg", "http://example.com/rock2.jpg"]
}
#
#
```

### Open Graph

To turn your web pages into graph objects, you'll need to add Open Graph protocol `` tags to your webpages. The tags allow you to specify structured information about your web pages. The more information you provide, the more opportunities your web pages can be surfaced within Facebook today and in the future. Here's an example for a movie page:

```ruby
set_meta_tags og: {
title: "The Rock",
type: "video.movie",
url: "http://www.imdb.com/title/tt0117500/",
image: "http://ia.media-imdb.com/rock.jpg",
video: {
director: "http://www.imdb.com/name/nm0000881/",
writer: ["http://www.imdb.com/name/nm0918711/", "http://www.imdb.com/name/nm0177018/"]
}
}
#
#
#
#
#
#
#
```

Multiple images declared as an **array** (look at the `_` character):

```ruby
set_meta_tags og: {
title: "Two structured image properties",
type: "website",
url: "view-source:http://examples.opengraphprotocol.us/image-array.html",
image: [
{
_: "http://examples.opengraphprotocol.us/media/images/75.png",
width: 75,
height: 75
},
{
_: "http://examples.opengraphprotocol.us/media/images/50.png",
width: 50,
height: 50
}
]
}
#
#
#
#
#
#
#
#
#
```

Article meta tags are supported too:

```ruby
set_meta_tags article: {
published_time: "2013-09-17T05:59:00+01:00",
modified_time: "2013-09-16T19:08:47+01:00",
section: "Article Section",
tag: "Article Tag"
}
#
#
#
#
```

Further reading:

- [Open Graph protocol](http://developers.facebook.com/docs/opengraph/)
- [Must-Have Social Meta Tags for Twitter, Google+, Facebook and More](https://moz.com/blog/meta-data-templates-123)

### Twitter Cards

Twitter cards make it possible for you to attach media experiences to Tweets that link to your content. There are 3 card types (summary, photo, and player). Here's an example for summary:

```ruby
set_meta_tags twitter: {
card: "summary",
site: "@username"
}
#
#
```

Take into consideration that if you're already using OpenGraph to describe data on your page, it’s easy to generate a Twitter card without duplicating your tags and data. When the Twitter card processor looks for tags on your page, it first checks for the Twitter property, and if not present, falls back to the supported Open Graph property. This allows both to be defined on the page independently and minimizes the amount of duplicate markup required to describe your content and experience.

When you need to generate a [Twitter Photo card](https://dev.twitter.com/docs/cards/types/photo-card), the `twitter:image` property is a string, while image dimensions are specified using `twitter:image:width` and `twitter:image:height`, or a `Hash` object in terms of MetaTags gems. There is a special syntax to make this work:

```ruby
set_meta_tags twitter: {
card: "photo",
image: {
_: "http://example.com/1.png",
width: 100,
height: 100
}
}
#
#
#
#
```

A special parameter `itemprop` can be used on an "anonymous" tag "\_" to generate the "itemprop" HTML attribute:

```ruby
set_meta_tags twitter: {
card: "photo",
image: {
_: "http://example.com/1.png",
width: 100,
height: 100,
itemprop: "image"
}
}
#
#
#
#
```

Further reading:

- [Twitter Cards Documentation](https://dev.twitter.com/cards/)

### App Links

App Links is an open cross-platform solution for deep linking to content in your mobile app. Here's an example of iOS app integration:

```ruby
set_meta_tags al: {
ios: {
url: "example://applinks",
app_store_id: 12345,
app_name: "Example App"
}
}
#
#
#
```

Further reading:

- [App Links Documentation](https://developers.facebook.com/docs/applinks)

### Custom meta tags

Starting from version 1.3.1, you can specify arbitrary meta tags, and they will be rendered on the page, even if the meta-tags gem does not know about them.

Example:

```ruby
set_meta_tags author: "Dmytro Shteflyuk"
#
```

You can also specify the value as an Array, and the values will be displayed as a list of `meta` tags:

```ruby
set_meta_tags author: ["Dmytro Shteflyuk", "John Doe"]
#
#
```

## Maintainers

[Dmytro Shteflyuk](https://github.com/kpumuk), [https://dmytro.sh](https://dmytro.sh)