SEO gem for your Middleman apps.
Based on meta-tags Rails gem.
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
Edit config.rb and add:
activate :meta_tagsset_meta_tags title: 'Relevant title'
title 'Relevant title'set_meta_tags description: 'Powerful website full of best practices and keywords'
description 'Powerful website full of best practices and keywords'set_meta_tags keywords: %w(some seo keywords).join(', ')
keywords %w(some seo keywords).join(', ')To set the HTTP Meta-Refresh property of a page, use the refresh key:
set_meta_tags refresh: "0;url=http://example.com/"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: '»'
If you want to enable auto meta tagging, put this in you <head></head> tag:
auto_display_meta_tagsThis 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=> METAtitle - MM
title=> METAtitle - MM
description=> METAdescription - MM
keywords=> METAkeywords - MM
twitter_card(defaults tosummary_large_image) => METAtwitter:card - MM
twitter_author=> METAtwitter:creator - MM
description=> METAtwitter:description - MM
thumbnail=> METAtwitter:image:src - MM
publisher_twitter=> METAtwitter:site - MM
title=> METAtwitter:title - MM
description=> METAog:description - MM
thumbnail=> METAog:image - MM
site=> METAog:site_name - MM
title=> METAog:title - MM
host=> optional attribute for composingthumbnailsrc with asset helper
In addition, if you want to customize meta tags by each page's frontmatter, you
can add customize_by_frontmatter: true in data/site.yml. The priority would
be set_meta_tags > frontmatter > site wide defaults.
Create a helper method inside of your config.rb, like so
helper do
def my_tags
set_meta_tags key => value
end
endAnd add it to the layouts and views that you need.
For the thumbnail to render for twitter metatags, a full url must be used:
thumbnail: 'http://example.com/path/to/image.jpg'
If pointing to an image in your Middleman source, you can instead specify the
relative image path as you would with an asset helper provided you have also
configured the host in your site.yml. If your Middleman build activates
extensions like :asset_hash, the full, hashed URL will be generated in your
metatags.
# site.yml
host: http://example.com
# your article
thumbnail 'page/to/image/jpg'
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
- Update
./lib/middleman-meta-tags/version.rband CHANGELOG.md gem build middleman-meta-tags.gemspecbundle exec rake release