Readme

Linkify #

Linkify 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.

Installation #

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

def deps do
  [{:linkify, git: "https://github.com/bonfire-networks/linkify"}]
end

Usage #

The following examples illustrate some examples on how to use the auto linker.


iex> Linkify.link("google.com")
"<a href=\"http://google.com\">google.com</a>"

iex> Linkify.link("google.com", class: "linkified")
"<a href=\"http://google.com\" class=\"linkified\">google.com</a>"

iex> Linkify.link("google.com", new_window: true)
"<a href=\"http://google.com\" target=\"_blank\">google.com</a>"

iex> Linkify.link("google.com", new_window: true, rel: "noopener noreferrer")
"<a href=\"http://google.com\" target=\"_blank\" rel=\"noopener noreferrer\">google.com</a>"

iex> Linkify.link("Hello @alice@social.com", mention: true, mention_prefix: "/users/")
"Hello <a href=\"/users/alice@social.com\">@alice@social.com</a>"

iex> Linkify.link("one #two three", hashtag: true, hashtag_prefix: "https://example.local/tag/")
"one <a href=\"https://example.local/tag/2two\">#two</a> three"

Acknowledgments #

This is a fork of Akkoma's Linkify, itself a fork of auto_linker by Steve Pallen.

License #

SPDX-License-Identifier: MIT AND CC0-1.0

Check REUSE Specification on how to get more information.