Go to file
Shadowfacts 75404b197d
Fix error when removing attributes from tree that contains comments
2021-09-22 21:08:52 -04:00
config Allow HTTPoison options to be specified in config 2016-10-18 09:54:00 -04:00
lib Fix error when removing attributes from tree that contains comments 2021-09-22 21:08:52 -04:00
test Fix error when removing attributes from tree that contains comments 2021-09-22 21:08:52 -04:00
.formatter.exs Add Elixir 1.6 formatter config file and formatted the codebase 2018-02-09 11:42:08 +08:00
.gitignore add ex_docs 2016-04-23 12:52:52 +09:00
.travis.yml Update minimum Elixir version requirement to 1.3.0 2017-11-03 23:40:18 +08:00
LICENSE Initial commit 2016-04-15 20:50:51 +09:00
README.md Updated README: minor grammar improvements as well as section for contributing 2018-10-20 09:45:21 +09:00
mix.exs Remove HTTPoison application 2020-08-15 10:13:18 -04:00
mix.lock Finish removing HTTPoison 2021-09-22 21:05:16 -04:00



Build Status Readability version Deps Status

Readability is a tool for extracting and curating the primary readable content of a webpage.
Check out The Documentation for full and detailed guides


If available in Hex, the package can be installed as:

  1. Add readability to your list of dependencies in mix.exs:
def deps do
  [{:readability, "~> 0.9"}]
  1. Ensure readability is started before your application:
def application do
  [applications: [:readability]]

Note: Readability requires Elixir 1.3 or higher.



Just pass a url

url = "https://medium.com/@kenmazaika/why-im-betting-on-elixir-7c8f847b58"
summary = Readability.summarize(url)

#=> "Why Im betting on Elixir"

#=> ["Ken Mazaika"]

# <div><div><p id=\"3476\"><strong><em>Background: </em></strong><em>Ive spent...
# ...
# ...button!</em></h3></div></div>

# Background: Ive spent the past 6 years building web applications in Ruby and.....
# ...
# ... value in this article, it would mean a lot to me if you hit the recommend button!

From raw html

### Extract the title.

### Extract authors.

### Extract the primary content with transformed html.
|> Readability.article
|> Readability.readable_html

### Extract only text from the primary content.
|> Readability.article
|> Readability.readable_text

### you can extract the primary images with Floki
|> Readability.article
|> Floki.find("img")
|> Floki.attribute("src")


If the result is different from your expectations, you can add options to customize it.


url = "https://medium.com/@kenmazaika/why-im-betting-on-elixir-7c8f847b58"
summary = Readability.summarize(url, [clean_conditionally: false])
  • min_text_length \\ 25
  • remove_unlikely_candidates \\ true
  • weight_classes \\ true
  • clean_conditionally \\ true
  • retry_length \\ 250

You can find other algorithm and regex options in readability.ex


To run the test suite:

$ mix test


  • Extract authors
  • More configurable
  • Summarize function
  • Convert relative paths into absolute paths of img#src and a#href

Contributions are welcome!

Check out the main features milestone and features of related projects below


  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

  • readability.js is a standalone version of the readability library used for Firefox Reader View.
  • newspaper is an advanced news extraction, article extraction, and content curation library for Python.
  • ruby-readability is a tool for extracting the primary readable content of a webpage.


This code is under the Apache License 2.0. See http://www.apache.org/licenses/LICENSE-2.0.