cheatsheets/meta-tags.md

102 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2016-06-01 04:25:44 +00:00
---
2017-09-08 06:11:04 +00:00
title: Meta-tags gem
2016-06-01 04:25:44 +00:00
category: Ruby libraries
2017-09-08 06:11:04 +00:00
weight: -1
2017-09-08 07:22:25 +00:00
updated: 2017-09-08
2016-06-01 04:25:44 +00:00
---
### Titles
2017-09-08 06:11:04 +00:00
```ruby
2016-06-01 04:25:44 +00:00
set_meta_tags title: 'Member Login'
# <title>Some Page Title</title>
2017-09-08 06:12:07 +00:00
```
```ruby
2016-06-01 04:25:44 +00:00
set_meta_tags site: 'Site Title', title: 'Member Login'
# <title>Site Title | Page Title</title>
2017-09-08 06:12:07 +00:00
```
```ruby
2017-09-08 06:13:13 +00:00
set_meta_tags(
site: 'Site Title',
title: 'Member Login',
reverse: true,
separator: '&middot;'.html_safe
)
# <title>Page Title · Site Title</title>
2016-06-01 04:25:44 +00:00
```
2017-09-08 06:12:07 +00:00
Works in a controller or a view.
2017-09-08 06:11:04 +00:00
### Setting defaults
```
rails generate meta_tags:install
```
This creates `config/initializers/meta_tags.rb` that you can edit.
2016-06-01 04:25:44 +00:00
### Others
2017-09-08 06:11:04 +00:00
```ruby
2017-09-08 06:17:30 +00:00
set_meta_tags site: 'Site name'
set_meta_tags title: 'Title'
2017-09-08 06:12:07 +00:00
set_meta_tags description: "All text about keywords"
2017-09-08 06:17:30 +00:00
```
```ruby
2016-06-01 04:25:44 +00:00
set_meta_tags keywords: %w[abc def ghi]
set_meta_tags canonical: 'http://...'
set_meta_tags icon: 'favicon.ico'
set_meta_tags author: 'http://...'
set_meta_tags alternate: { 'fr' => 'http://...' }
set_meta_tags prev: 'http://...'
set_meta_tags next: 'http://...'
2017-09-08 06:17:30 +00:00
set_meta_tags image_src: 'http://...'
```
```ruby
set_meta_tags noindex: true
set_meta_tags nofollow: true
set_meta_tags follow: true
```
```ruby
2016-06-01 04:25:44 +00:00
set_meta_tags og: { image: ['...'] }
2017-09-08 06:17:30 +00:00
set_meta_tags twitter: { description: '...' }
```
```ruby
set_meta_tags separator: '·' # Site · Page title
set_meta_tags prefix: ' ' # Around the separator
set_meta_tags suffix: ' '
```
```ruby
set_meta_tags lowercase: true # Lowercase page title
set_meta_tags reverse: true # Site name last
2016-06-01 04:25:44 +00:00
```
### In views
2017-09-08 06:11:04 +00:00
```ruby
# Displaying tags
2016-06-01 04:25:44 +00:00
<%= display_meta_tags %>
```
2017-09-08 06:11:04 +00:00
```ruby
# Displaying tags individually
<h1><%= title %></h1>
```
```ruby
# Setting tags
2016-06-01 04:25:44 +00:00
<% title 'Member Login' %>
<% description 'My page' %>
<% keywords '..' %>
```
### Reference
2017-09-08 06:11:04 +00:00
- Accurate as of 2.1.0. See: <https://github.com/kpumuk/meta-tags>