Current section
Files
Jump to
Current section
Files
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.28.4">
<meta name="project" content="readability2 v0.6.0">
<title>API Reference — readability2 v0.6.0</title>
<link rel="stylesheet" href="dist/elixir-b6f1ed5df9b1d42a7309.css" />
<script src="dist/sidebar_items-dd6dff8ac1.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/app-bd1cb213813bf4825aa2.js"></script>
</head>
<body data-type="extras">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<section class="sidebar">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="api-reference.html" class="sidebar-projectName" translate="no">
readability2
</a>
<strong class="sidebar-projectVersion" translate="no">
v0.6.0
</strong>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<span>API Reference <small class="app-vsn">readability2 v0.6.0</small></span>
</h1>
<section class="details-list">
<h2 id="modules" class="section-heading">
<a href="#modules" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">modules</p>
</a>
Modules
</h2>
<div class="summary">
<div class="summary-row">
<div class="summary-signature">
<a href="Readability.html" translate="no">Readability</a>
</div>
<div class="summary-synopsis"><p>Readability library for extracting & curating articles.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Readability.ArticleBuilder.html" translate="no">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" translate="no">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" translate="no">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" translate="no">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" translate="no">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" translate="no">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" translate="no">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" translate="no">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 & embeds, etc.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Readability.Summary.html" translate="no">Readability.Summary</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Readability.TitleFinder.html" translate="no">Readability.TitleFinder</a>
</div>
<div class="summary-synopsis"><p>The TitleFinder engine traverses HTML tree searching for finding title.</p></div>
</div>
</div>
</section>
<div class="bottom-actions">
<div class="bottom-actions-item">
</div>
<div class="bottom-actions-item">
</div>
</div>
<footer class="footer">
<p>
On Hex.pm:
<span class="line">
<a href="https://hex.pm/packages/readability2/0.6.0" class="line footer-hex-package">Package</a>
<a href="https://preview.hex.pm/preview/readability2/0.6.0" class="line">Preview</a>
</span>
<button class="line footer-button display-quick-switch">
Search
</button>
</p>
<p>
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.28.4) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>