ToddAT / middleman-meta-tags

Easy integration of meta tags into your Middleman applications

Home Page:rubygems.org/gems/middleman-meta-tags

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Middleman MetaTags

SEO gem for your Middleman apps.

Based on meta-tags Rails gem.

Installation

Add this line to your application's Gemfile:

gem 'middleman-meta-tags'

And then execute:

$ bundle

Or install it yourself as:

$ gem install middleman-meta-tags

Usage

Configuration

Edit config.rb and add:

activate :meta_tags

Title

set_meta_tags title: 'Relevant title'
title 'Relevant title'

Description

set_meta_tags description: 'Powerful website full of best practices and keywords'
description 'Powerful website full of best practices and keywords'

Keywords

set_meta_tags keywords: %w(some seo keywords).join(', ')
keywords %w(some seo keywords).join(', ')

Display meta tags

Into your <head></head> tag:

display_meta_tags site: 'My Awesome Website'

By default, there is a | as separator between title and website name.

You can modify it by adding: separator: '&raquo;'

Autotagging

If you want to enable auto meta tagging, put this in you <head></head> tag:

auto_display_meta_tags

This will look inside of data/site.yml file to find any site wide defaults. Then it looks the page meta data to attempt to display the following keys:

  • MM site => META title
  • MM title => META title
  • MM description => META description
  • MM keywords => META keywords
  • MM twitter_card (defaults to summary_large_image) => META twitter:card
  • MM twitter_author => META twitter:creator
  • MM description => META twitter:description
  • MM pull_image => META twitter:image:src
  • MM publisher_twitter => META twitter:site
  • MM title => META twitter:title
  • MM description => META og:description
  • MM pull_image => META og:image
  • MM site => META og:site_name
  • MM title => META og:title

Manually adding addition tags

Create a helper method inside of your config.rb, like so

helper do
  def my_tags
    set_meta_tags key => value
  end
end

And add it to the layouts and views that you need.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About

Easy integration of meta tags into your Middleman applications

rubygems.org/gems/middleman-meta-tags

License:MIT License


Languages

Language:Ruby 100.0%