Skip to content

zhonger/jekyll-extlinks

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jekyll ExtLinks

This Jekyll plugin adds custom attributes (rel="nofollow", target="_blank", etc.) to external links in your content.

This Jekyll plugin adds custom attributes to external links in your content. For example, you can add rel="nofollow" to all external links by default (with exceptions if you need them), or something like class="external". You can also use it to add target="_blank" to external links, but generally it is not recommended as it leads to bad user experience. Multiple attributes are allowed.

Installation

  1. Install the gem from RubyGems: gem install h2o-ac-jekyll-extlinks.

  2. Add this to your project's Gemfile:

gem 'h2o-ac-jekyll-extlinks'
  1. Add this to your project's _config.yml:
plugins:
  - jekyll-extlinks

Configuration

Configure the plugin in your _config.yml. Notice the indentation matters. Example:

extlinks:
  attributes: {rel: nofollow, target: _blank, class: external}
  rel_exclude: ['host1.com', 'host2.net']
  class_exclude: ['host1.com', 'host2.net']
  • attributes are required - at least one of them; rel_exclude and class_exclude are optional
  • Links to hosts listed in rel_exclude will not have the rel attribute set
  • Links to hosts listed in class_exclude will not have the class attribute set
  • Links which have the rel attribute already will keep it unchanged, like this one in Markdown: [Link text](http://someurl.com){:rel="dofollow"}
  • Relative links will not be processed
  • Don't forget to actually use the plugin (see below)

Usage

Use the plugin in your Jekyll layouts: {{ content | extlinks }}

Notes

Developed by Dmitry Ogarkov - http://ogarkov.com/jekyll/plugins/extlinks/

Based on http://dev.mensfeld.pl/2014/12/rackrails-middleware-that-will-ensure-relnofollow-for-all-your-links/

Revised by zhonger - https://github.com/zhonger/jekyll-extlinks

About

This Jekyll plugin adds custom attributes (rel="nofollow", target="_blank", etc.) to external links in your content.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 100.0%