https://github.com/ivantsepp/jekyll-autolink_email

Autolink emails for your Jekyll
https://github.com/ivantsepp/jekyll-autolink_email

Last synced: about 2 months ago
JSON representation

Autolink emails for your Jekyll

• Host: GitHub
• URL: https://github.com/ivantsepp/jekyll-autolink_email
• Owner: ivantsepp
• License: mit
• Created: 2014-06-12T04:17:56.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-03-30T18:23:32.000Z (over 2 years ago)
• Last Synced: 2024-04-24T17:08:27.339Z (5 months ago)
• Language: Ruby
• Homepage:
• Size: 10.7 KB
• Stars: 14
• Watchers: 3
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-jekyll-plugins - **Autolink Email** - autolink_email](https://rubygems.org/gems/jekyll-autolink_email) by Ivan Tse -- Autolink your emails. (Generators)

README

        
# Jekyll::AutolinkEmail

Autolink emails for your Jekyll site.

## Installation

Add to your `Gemfile`:

```

gem 'jekyll-autolink_email'

```

Add to your `_config.yml`:

```yml

gems:

  - jekyll-autolink_email

```

## Usage

In any html page or post, emails will be autolinked. So if you write `[email protected]`, the resulting html will be `[email protected]`

## Configuration

Autolinking is done by [Rinku](https://github.com/vmg/rinku) so visit that gem for a more in-depth explanation of the configuration options:

```yml

autolink_email:

  link_attr: class='email-link' # attributes to add to the link

  skip_tags: ['div']            # tags to skip

```

Jekyll::AutolinkEmail also provides a `escape: true` option. Turning this on will html encode the email address and url encode the link to prevent spam.

## Contributing

1. Fork it ( https://github.com/ivantsepp/jekyll-autolink_email/fork )

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 a new Pull Request

You should also check out [Jemoji](https://github.com/jekyll/jemoji) and [Jekyll Mentions](https://github.com/jekyll/jekyll-mentions) as those gems were the source of inspiration for this gem.