logo

auto_linker

AutoLinker-shim, based on https://git.pleroma.social/pleroma/auto_linker git clone https://hacktivis.me/git/auto_linker.git

README.md (1474B)

    

  1. # Linkify
  3. Linkify is a basic package for turning website names into links.
  5. Use this package in your web view to convert web references into click-able links.
  7. ## Installation
  9. The package can be installed by adding `linkify` to your list of dependencies in `mix.exs`:
  11. ```elixir
  12. def deps do
  13.   [{:linkify, "~> 0.3"}]
  14. end
  15. ```
  17. ## Usage
  19. The following examples illustrate some examples on how to use the auto linker.
  21. ```elixir
  23. iex> Linkify.link("google.com")
  24. "<a href=\"http://google.com\">google.com</a>"
  26. iex> Linkify.link("google.com", class: "linkified")
  27. "<a href=\"http://google.com\" class=\"linkified\">google.com</a>"
  29. iex> Linkify.link("google.com", new_window: true)
  30. "<a href=\"http://google.com\" target=\"_blank\">google.com</a>"
  32. iex> Linkify.link("google.com", new_window: true, rel: "noopener noreferrer")
  33. "<a href=\"http://google.com\" target=\"_blank\" rel=\"noopener noreferrer\">google.com</a>"
  35. iex> Linkify.link("Hello @niceguy17@pleroma.com", mention: true, mention_prefix: "/users/")
  36. "Hello <a href=\"/users/niceguy17@pleroma.com\">@niceguy17@pleroma.com</a>"
  37. ```
  39. See the [Docs](https://hexdocs.pm/linkify/) for more examples
  41. ## Acknowledgments
  43. This is a fork of [auto_linker](https://github.com/smpallen99/auto_linker) by [Steve Pallen](https://github.com/smpallen99).
  45. ## License
  47. Copyright © 2017 E-MetroTel
  49. Copyright © 2019-2020 Pleroma Authors
  51. The source is released under the MIT License.
  53. Check [LICENSE](LICENSE) for more information.