🔗 Auto link for Crystal
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
spec
src
.editorconfig
.gitignore
.travis.yml
LICENSE
README.md
shard.yml

README.md

🔗 Autolink Build Status

Autolink.cr is a Crystal shard that automatically turns URLs into links.

Example:

auto_link("Welcome to my profile https://github.com/hugoabonizio")
# => Welcome to my profile <a href="https://github.com/hugoabonizio">https://github.com/hugoabonizio</a>

Installation

Add this to your application's shard.yml:

dependencies:
  autolink:
    github: crystal-community/autolink.cr

Usage

require "autolink"

include Autolink

auto_link("My blog: http://www.myblog.com/", html: {"class" => "menu", "target" => "_blank"})
# => My blog: <a href="http://www.myblog.com/" class="menu" target="_blank">http://www.myblog.com/</a>

Simple autolink

Without providing any HTML options autolink.cr will just wrap the URL with <a> tag.

Autolink.auto_link("Welcome to my new blog at http://www.myblog.com/")
# => Welcome to my new blog at <a href="http://www.myblog.com/">http://www.myblog.com/</a>

Custom tag attributes

The <a> tag can receive custom attributes.

Autolink.auto_link("My blog: http://www.myblog.com/", html: {"class" => "menu", "target" => "_blank"})
# => My blog: <a href="http://www.myblog.com/" class="menu" target="_blank">http://www.myblog.com/</a>

Contributing

  1. Fork it ( https://github.com/crystal-community/autolink.cr/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

Contributors

This project is a port to Crystal of rails_autolink Ruby gem. Thanks to all its contributors.