English
资源说明：Search Engine Optimization (SEO) for Ruby on Rails applications.
# MetaTags: a gem to make your Rails application SEO-friendly [](https://circleci.com/gh/kpumuk/meta-tags) [](https://badge.fury.io/rb/meta-tags) [](https://codeclimate.com/github/kpumuk/meta-tags) [](https://codeclimate.com/github/kpumuk/meta-tags/coverage) [](https://badge.fury.io/rb/meta-tags) [](https://github.com/kpumuk/meta-tags/blob/main/CHANGELOG.md) Search Engine Optimization (SEO) plugin for Ruby on Rails applications. ## Ruby on Rails MetaTags main branch fully supports Ruby on Rails 5.1+, and is tested against all major Rails releases up to 6.1. Ruby versions older than 2.5 are no longer officially supported. _Please note_ that we are no longer support Ruby versions older than 2.4.0 and Ruby on Rails older than 5.1, because they [reached their End of Life](https://github.com/kpumuk/meta-tags/pull/143). ## 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`. Since, some meta tags are required to use `property` instead (like Facebook Open Graph object), MetaTags gem allows to configure which tags to render with `property` attribute. By default the pre-configured list includes all possible Facebook Open Graph object types, 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: ```htmlMy website | My page title My page title
``` You can find allowed options for `display_meta_tags` method below. ### Using MetaTags in controller You can define following instance variables: ```ruby @page_title = 'Member Login' @page_description = 'Member login page.' @page_keywords = 'Site, Login, Members' ``` Also you could use `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 allowed options for `set_meta_tags` method below. ### Using MetaTags in view To set meta tags you can use following methods: ```erb <% title 'Member Login' %> <% description 'Member login page.' %> <% keywords 'Site, Login, Members' %> <% nofollow %> <% noindex %> <% refresh 3 %> ``` Also there is `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 `#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 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 website name from 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 string of comma-separated values, or as an array: ```ruby set_meta_tags keywords: ['tag1', 'tag2'] # tag1, tag2 ``` Description is a string (HTML will be stripped from output string). ### Mirrored values Sometimes, it is desirable to mirror meta tag values down into namespaces. A common use case is when you want open graph's `og:title` to be identical to the `title`. Say, you have the following in your application layout: ```ruby display_meta_tags og: { title: :title, site_name: :site, } ``` The value of `og[:title]` is a symbol and therefore references the value of the top level `title` meta tag. With the following in any view: ```ruby title 'my great view' ``` You get this open graph meta tag for free: ```html ``` Please note, that title does not include site. If you need to reference the exact value rendered in the `` meta tag, use `:full_title`. ### Using with Turbolinks [Turbolinks](https://github.com/turbolinks/turbolinks) 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 Turbolinks out of the box, no configuration is necessary. ### Using with pjax [jQuery.pjax](https://github.com/defunkt/jquery-pjax) is a nice solution for navigation without full page reload. The main difference is that layout file will not be rendered, so 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 `display_title` method, which returns fully resolved page title (include site, prefix/suffix, etc.) But in this case you will have to set default parameters (e.g, `:site`) both in 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 <!-- set title here, so we can use it both in "display_title" and in "title" --> <% title "My Page title" %> <%= content_tag :div, data: { title: display_title(default_meta_tags) } do %> <h1><%= title %></h1> <!-- HTML goes here --> <% 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. The search engines look at the title bar to determine what the page is all about. ```ruby set_meta_tags title: 'Member Login' # <title>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, 10 words. Further reading: - [Title Tag](https://moz.com/learn/seo/title-tag) ### Description Description tags are called meta tags as they are not displayed by the browsers unlike the titles. However, these descriptions may be displayed by some search engines. They are used to describe the contents of a page in 2 or 3 sentences. ```ruby set_meta_tags description: "All text about keywords, other keywords" # ``` Recommended description tag length: up 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 tag are used to place your keywords that you think a surfer would search in Search engines. Repeating keywords unnecessarily would be considered spam and you may get permanently banned from SERP's ```ruby set_meta_tags keywords: %w[keyword1 Keyword2 KeyWord3] # ``` Recommended keywords tag length: up to 255 characters, 20 words. **Please note**, that both Google and Bing publicly indicated that keywords meta tags is completely ignored. ### Noindex By using the noindex meta tag, you can signal to search engines to not 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 default value for Google, some SEO specialists recommend to add it to website ```ruby set_meta_tags index: true # ``` ### Nofollow Nofollow meta tag tells a search engine not to follow the links on a specific page. It's entirely likely that a robot might find the same links on some other page without a nofollow (perhaps on some other site), and so still arrives 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 Follow will work with Noindex meta tag ```ruby set_meta_tags noindex: true, follow: true # ``` It will not look at this page but will crawl through the rest of the pages on your website. ### Canonical URL Canonical link element tells a search engine what is the canonical or main URL for a content which have multiple URLs. The search engine will always return that URL, and link popularity and authority will be applied to that URL. Note: If you like follow a hint of John Mueller that you shouldn't 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, Web site icon, tab icon or bookmark icon, is a file containing one or more small icons, most commonly 16×16 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 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 , this 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 way to build web pages for static content that render fast. If you have two versions of the page – non-AMP and AMP, you can link the AMP version from normal one using `amphtml` tag: ```ruby set_meta_tags amphtml: url_for(format: :amp, only_path: false) # ``` To link back to normal version, use `canonical`. - [What Is AMP?](https://www.ampproject.org/learn/about-amp/) - [Make Your Page Discoverable](https://www.ampproject.org/docs/guides/discovery) ### Manifest links ```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 link element 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 built just passing any symbol name and a Hash. For example: ```ruby set_meta_tags foo: { bar: "lorem", baz: { qux: "ipsum" } } # # ``` ### Arrays Repeated meta tags can be built just using an Array inside 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 in 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 for 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), `twitter:image` property is a string, while image dimensions are specified using `twitter:image:width` and `twitter:image:height`, or a `Hash` objects 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, } } # # # # ``` Special parameter `itemprop` can be used on a "anonymous" tag "\_" to generate "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 for 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 meta-tags gem does not know about them. Example: ```ruby set_meta_tags author: "Dmytro Shteflyuk" # ``` You can also specify value as an Array, and 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://kpumuk.info](http://kpumuk.info/)
本源码包内暂不包含可直接显示的源代码文件，请下载源码包。
