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.31.0">
<meta name="project" content="readability v0.12.0">
<title>API Reference — readability v0.12.0</title>
<link rel="stylesheet" href="dist/html-elixir-3ZLIM5JF.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
<script src="dist/sidebar_items-509E9CD8.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-CILPWI2Q.js"></script>
</head>
<body data-type="extras" class="page-extra">
<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">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<nav id="sidebar" class="sidebar">
<div class="sidebar-header">
<div class="sidebar-projectInfo">
<div>
<a href="readme.html" class="sidebar-projectName" translate="no">
readability
</a>
<div class="sidebar-projectVersion" translate="no">
v0.12.0
</div>
</div>
</div>
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
<li>
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
Pages
</button>
</li>
<li>
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
Modules
</button>
</li>
</ul>
</div>
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
<ul id="extras-full-list" class="full-list"></ul>
</div>
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
<ul id="modules-full-list" class="full-list"></ul>
</div>
</nav>
<main class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<div class="top-search">
<div class="search-settings">
<form class="search-bar" action="search.html">
<label class="search-label">
<span class="sr-only">Search documentation of readability</span>
<input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
<i class="ri-close-line ri-lg" title="Cancel search"></i>
</button>
</form>
<button class="icon-settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
</div>
</div>
<div class="autocomplete">
</div>
<h1>
<a href="https://github.com/keepcosmos/readability" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span>API Reference <small class="app-vsn">readability v0.12.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>
</a>
<span class="text">Modules</span>
</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.</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.</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, and removing HTML tree.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="Readability.Queries.html" translate="no">Readability.Queries</a>
</div>
<div class="summary-synopsis"><p>Highly-optimized utilities for quick answers about 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.</p></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">
<a href="license.html" class="bottom-actions-button" rel="next">
<span class="subheader">
Next Page →
</span>
<span class="title">
License
</span>
</a>
</div>
</div>
<footer class="footer">
<p>
<span class="line">
<a href="https://hex.pm/packages/readability/0.12.0" class="footer-hex-package">Hex Package</a>
<a href="https://preview.hex.pm/preview/readability/0.12.0">Hex Preview</a>
</span>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.0) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</main>
</div>
</body>
</html>