Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jumph4x/canonical-rails

Quick and configurable canonical tag to use in Rails views.
https://github.com/jumph4x/canonical-rails

Last synced: 3 months ago
JSON representation

Quick and configurable canonical tag to use in Rails views.

Awesome Lists containing this project

README

        

CanonicalRails
==============
[![latest builds](https://github.com/jumph4x/canonical-rails/actions/workflows/ruby.yml/badge.svg)](https://github.com/jumph4x/canonical-rails/actions/workflows/ruby.yml)

A number of articles exist explaining the issue concisely and at length:

* [Google Webmaster Blog Page About Specifying Canonical](http://googlewebmastercentral.blogspot.com/2009/02/specify-your-canonical.html)
* [Google Support About rel="canonical"](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=139394)
* [Google Support About Canonicalization](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=139066)

## Guide

Take a look at this blog post that can guide you through the idea and the setup: [Easily add canonical URLs to your Rails app](http://blog.planetargon.com/entries/2014/4/4/easily-add-canonical-urls-to-your-rails-app)

## Challenge

I've seen a lot of folks do more harm by neglecting canonicalization altogether than by applying too narrowly and conservatively, so here is an attempt to let people start modestly without spending too much time on it and whitelist parameters as they need to.

## Install

gem 'canonical-rails', github: 'jumph4x/canonical-rails'

## Usage

First, generate the config

rails g canonical_rails:install

Then find it in config/initializers/ as canonical_rails.rb

Finally, include the canonical_tag helper inside the `head` portion of
your HTML views:
```ruby
<%= canonical_tag -%>
```

## Cred

Originally developed for [FCP Euro - High Quality European Car Parts](https://www.fcpeuro.com).