readability v0.7.0 Readability

Readability library for extracting & curating articles.

Example

@type html :: binary

# Just pass url
%Readability.Summary{title: title, authors: authors, article_html: article} = Readability.summarize(url)

# Extract title
Readability.title(html)

# Extract authors.
Readability.authors(html)

# Extract only text from article
article = html
          |> Readability.article
          |> Readability.readable_text

# Extract article with transformed html
article = html
          |> Readability.article
          |> Readability.raw_html

Summary

Functions

Using a variety of metrics (content score, classname, element types), find the content that is most likely to be the stuff a user wants to read

Extract authors

return raw html binary from html_tree

return attributes, tags cleaned html

return only text binary from html_tree

summarize the primary readable content of a webpage

Extract title

Types

html_tree()
html_tree() :: tuple | list
options()
options() :: list
raw_html()
raw_html() :: binary
url()
url() :: binary

Functions

article(raw_html, opts \\ [])
article(binary, options) :: html_tree

Using a variety of metrics (content score, classname, element types), find the content that is most likely to be the stuff a user wants to read

Example

iex> article_tree = Redability(html_str)
# returns article that is tuple
authors(html)
authors(binary | html_tree) :: list[binary]

Extract authors

Example

iex> authors = Readability.authors(html_str)
["José Valim", "chrismccord"]
default_options()
parse(raw_html)
raw_html(html_tree)
raw_html(html_tree) :: binary

return raw html binary from html_tree

readable_html(html_tree)
readable_html(html_tree) :: binary

return attributes, tags cleaned html

readable_text(html_tree)
readable_text(html_tree) :: binary

return only text binary from html_tree

regexes(key)
summarize(url, opts \\ [])

summarize the primary readable content of a webpage.

title(raw_html)
title(binary | html_tree) :: binary

Extract title

Example

iex> title = Readability.title(html_str)
"Some title in html"