Packages

readability

0.9.0
0.12.1 0.12.0 0.10.0 0.9.1 0.9.0 0.8.0 0.7.0 0.6.2 0.6.1 0.6.0 0.5.2 0.5.1 0.5.0 0.4.0 0.3.1 0.0.1

Readability library for extracting and curating articles.

HexDocs

Current section

Files

Jump to
Readme
16 Versions
2 Dependencies
Dependants
Files
Activity
readability doc api-reference.html
Raw

doc/api-reference.html 

<!DOCTYPE html>

<html lang="en">

  <head>

    <meta charset="utf-8">

    <meta http-equiv="x-ua-compatible" content="ie=edge">

    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <meta name="generator" content="ExDoc v0.16.3">

    <title>API Reference – readability v0.9.0</title>

    <link rel="stylesheet" href="dist/app-5b9e160cec.css" />

    

      <link rel="canonical" href="https://hexdocs.pm/readability/api-reference.html" />

    

    <script src="dist/sidebar_items-1e7383fe31.js"></script>

    

  </head>

  <body data-type="extras">

    <script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>



<div class="main">

<button class="sidebar-toggle">

  <span class="icon-menu" aria-hidden="true"></span>

  <span class="sr-only">Toggle Sidebar</span>

</button>

<section class="sidebar">



  

  <a href="api-reference.html" class="sidebar-projectLink">

    <div class="sidebar-projectDetails">

      <h1 class="sidebar-projectName">

        readability

      </h1>

      <h2 class="sidebar-projectVersion">

        v0.9.0

      </h2>

    </div>

    

  </a>



  <form class="sidebar-search" action="search.html">

    <button type="submit" class="search-button">

      <span class="icon-search" aria-hidden="true"></span>

    </button>

    <input name="q" type="text" id="search-list" class="search-input" placeholder="search" aria-label="Search" autocomplete="off" />

  </form>



  <ul class="sidebar-listNav">

    <li><a id="extras-list" href="#full-list">Pages</a></li>



    

      <li><a id="modules-list" href="#full-list">Modules</a></li>

    



    



    



    

  </ul>

  <div class="gradient"></div>

  <ul id="full-list" class="sidebar-fullList"></ul>

</section>



<section class="content">

  <div class="content-outer">

    <div id="content" class="content-inner">





<h1>

  <small class="visible-xs">readability v0.9.0</small>

  API Reference

</h1>





  <section class="details-list">

    <h2 id="modules" class="section-heading">

  <a href="#modules" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>

  Modules

</h2>



    <div class="summary">

      <div class="summary-row">

  <div class="summary-signature"><a href="Readability.html">Readability</a></div>

  

    <div class="summary-synopsis"><p>Readability library for extracting &amp; curating articles</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Readability.ArticleBuilder.html">Readability.ArticleBuilder</a></div>

  

    <div class="summary-synopsis"><p>Build article for readability</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Readability.AuthorFinder.html">Readability.AuthorFinder</a></div>

  

    <div class="summary-synopsis"><p>AuthorFinder extracts authors</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Readability.Candidate.html">Readability.Candidate</a></div>

  

    <div class="summary-synopsis"><p>Candidate can be article</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Readability.Candidate.Cleaner.html">Readability.Candidate.Cleaner</a></div>

  

    <div class="summary-synopsis"><p>Clean html tree for prepare candidates.

It transforms misused tags and removes unlikely candidates</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Readability.Candidate.Scoring.html">Readability.Candidate.Scoring</a></div>

  

    <div class="summary-synopsis"><p>Score html tree</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Readability.CandidateFinder.html">Readability.CandidateFinder</a></div>

  

    <div class="summary-synopsis"><p>The builing and finding candidates  engine

It traverses the HTML tree searching, removing, socring nodes</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Readability.Helper.html">Readability.Helper</a></div>

  

    <div class="summary-synopsis"><p>Helpers for parsing, updating, removing html tree</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Readability.Sanitizer.html">Readability.Sanitizer</a></div>

  

    <div class="summary-synopsis"><p>Clean an element of all tags of type “tag” if they look fishy.

“Fishy” is an algorithm based on content length, classnames, link density, number of images &amp; embeds, etc</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Readability.Summary.html">Readability.Summary</a></div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Readability.TitleFinder.html">Readability.TitleFinder</a></div>

  

    <div class="summary-synopsis"><p>The TitleFinder engine traverses HTML tree searching for finding title</p>

</div>

  

</div>



    </div>

  </section>

















      <footer class="footer">

        <p>

          <span class="line">

            Built using

            <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.16.3),

          </span>

          <span class="line">

            designed by

            <a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.

            </span>

        </p>

        <button class="night-mode-toggle"><span class="sr-only">Switch theme</span></button>

      </footer>

    </div>

  </div>

</section>

</div>

  <script src="dist/app-da04b39d0c.js"></script>

  

  </body>

</html>