sam/linkify
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
linkify/README.md
Stephen M. Pallen 59d41265fc prep for first release
2017-03-29 16:27:13 -04:00

1.4 KiB
Raw Blame History

AutoLinker

Build Status Hex Version License

AutoLinker is a basic package for turning website names into links.

Use this package in your web view to convert web references into click-able links.

This is a very early version. Some of the described options are not yet functional.

Installation

The package can be installed by adding auto_linker to your list of dependencies in mix.exs:

def deps do
  [{:auto_linker, "~> 0.1"}]
end

Usage

iex> AutoLinker.link("google.com")
"<a href='http://google.com' class='auto-linker' target='_blank' rel='noopener noreferrer'>google.com</a>"

iex> AutoLinker.link("google.com", new_window: false, rel: false)
"<a href='http://google.com' class='auto-linker'>google.com</a>"

iex> AutoLinker.link("google.com", new_window: false, rel: false, class: false)
"<a href='http://google.com'>google.com</a>"

See the docs for more examples

License

auto_linker is Copyright (c) 2017 E-MetroTel

The source is released under the MIT License.

Check LICENSE for more information.