OSDN Git Service

Regular updates
[twpd/master.git] / meta-tags.md
1 ---
2 title: Meta-tags gem
3 category: Ruby libraries
4 layout: 2017/sheet
5 weight: -1
6 updated: 2017-09-08
7 ---
8
9 ### Titles
10
11 ```ruby
12 set_meta_tags title: 'Member Login'
13 # <title>Some Page Title</title>
14 ```
15
16 ```ruby
17 set_meta_tags site: 'Site Title', title: 'Member Login'
18 # <title>Site Title | Page Title</title>
19 ```
20
21 ```ruby
22 set_meta_tags(
23   site: 'Site Title',
24   title: 'Member Login',
25   reverse: true,
26   separator: '&middot;'.html_safe
27 )
28 # <title>Page Title · Site Title</title>
29 ```
30
31 Works in a controller or a view.
32
33 ### Setting defaults
34
35 ```
36 rails generate meta_tags:install
37 ```
38
39 This creates `config/initializers/meta_tags.rb` that you can edit.
40
41 ### Others
42
43 ```ruby
44 set_meta_tags site: 'Site name'
45 set_meta_tags title: 'Title'
46 set_meta_tags description: "All text about keywords"
47 ```
48
49 ```ruby
50 set_meta_tags keywords: %w[abc def ghi]
51 set_meta_tags canonical: 'http://...'
52 set_meta_tags icon: 'favicon.ico'
53 set_meta_tags author: 'http://...'
54 set_meta_tags alternate: { 'fr' => 'http://...' }
55 set_meta_tags prev: 'http://...'
56 set_meta_tags next: 'http://...'
57 set_meta_tags image_src: 'http://...'
58 ```
59
60 ```ruby
61 set_meta_tags noindex: true
62 set_meta_tags nofollow: true
63 set_meta_tags follow: true
64 ```
65
66 ```ruby
67 set_meta_tags og: { image: ['...'] }
68 set_meta_tags twitter: { description: '...' }
69 ```
70 ```ruby
71 set_meta_tags separator: '·'   # Site · Page title
72 set_meta_tags prefix: ' '      # Around the separator
73 set_meta_tags suffix: ' '
74 ```
75
76 ```ruby
77 set_meta_tags lowercase: true  # Lowercase page title
78 set_meta_tags reverse: true    # Site name last
79 ```
80
81 ### In views
82
83 ```ruby
84 # Displaying tags
85 <%= display_meta_tags %>
86 ```
87
88 ```ruby
89 # Displaying tags individually
90 <h1><%= title %></h1>
91 ```
92
93 ```ruby
94 # Setting tags
95 <% title 'Member Login' %>
96 <% description 'My page' %>
97 <% keywords '..' %>
98 ```
99
100 ### Reference
101
102 - Accurate as of 2.1.0. See: <https://github.com/kpumuk/meta-tags>