Sha256: a8b14c8d6da6d75912621911a3672da8b4c4ad07cd5a62eb2d8de20356fddded
Contents?: true
Size: 1.64 KB
Versions: 2
Compression:
Stored size: 1.64 KB
Contents
# Jekyll Email Protect [](http://badge.fury.io/rb/jekyll-email-protect) > Email protection liquid filter for Jekyll Jekyll Email Protect is an email protection liquid filter which can be used to obfuscate `mailto:` links to protect an email address from span bots. ## Installation This plugin is available as a [RubyGem][ruby-gem]. Add this line to your application's `Gemfile`: ``` gem 'jekyll-email-protect' ``` And then execute the `bundle` command to install the gem. Alternatively, you can also manually install the gem using the following command: ``` $ gem install jekyll-email-protect ``` After the plugin has been installed successfully, add the following lines to your `_config.yml` in order to tell Jekyll to use the plugin: ``` gems: - jekyll-email-protect ``` ## Getting Started In your markup, simply use the `protect_email` liquid filter made available through this plugin: ``` {{ 'example@example.com' | encode_email }} ``` The above code will yield `%65%78%61%6D%70%6C%65@%65%78%61%6D%70%6C%65.%63%6F%6D`. Only use this filter within the `href` attribute of a given link. ## Example The following example shows how this plugin can be used to protect the `site`'s email address: ``` <a href="mailto:{{ site.email | protect_email }}" title="Contact me">Contact me</a> ``` # Contribute Fork this repository, make your changes and then issue a pull request. If you find bugs or have new ideas that you do not want to implement yourself, file a bug report. # Copyright Copyright (c) 2015 Vincent Wochnik. License: MIT [ruby-gem]: https://rubygems.org/gems/jekyll-language-plugin
Version data entries
2 entries across 2 versions & 1 rubygems
Version | Path |
---|---|
jekyll-email-protect-1.0.3 | README.md |
jekyll-email-protect-1.0.1 | README.md |