Current section

Files

Jump to
readability doc Readability.Candidate.Cleaner.html
Raw

doc/Readability.Candidate.Cleaner.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>Readability.Candidate.Cleaner – readability v0.9.0</title>
<link rel="stylesheet" href="dist/app-5b9e160cec.css" />
<link rel="canonical" href="https://hexdocs.pm/readability/Readability.Candidate.Cleaner.html" />
<script src="dist/sidebar_items-1e7383fe31.js"></script>
</head>
<body data-type="modules">
<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>
Readability.Candidate.Cleaner
</h1>
<section id="moduledoc">
<p>Clean html tree for prepare candidates.
It transforms misused tags and removes unlikely candidates.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:html_tree/0">html_tree()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#remove_unlikely_tree/1">remove_unlikely_tree(html_tree)</a>
</div>
<div class="summary-synopsis"><p>Remove unlikely html tree</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#transform_misused_div_to_p/1">transform_misused_div_to_p(content)</a>
</div>
<div class="summary-synopsis"><p>Transform misused divs <div>s that do not contain other block elements into <p>s</p>
</div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Types
</h1>
<div class="types-list">
<div class="detail" id="t:html_tree/0">
<div class="detail-header">
<a href="#t:html_tree/0" class="detail-link" title="Link to this type">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this type</span>
</a>
<span class="signature">html_tree()</span>
<div class="specs">
<pre>html_tree() :: tuple | list</pre>
</div>
</div>
<section class="docstring">
</section>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="detail" id="remove_unlikely_tree/1">
<div class="detail-header">
<a href="#remove_unlikely_tree/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">remove_unlikely_tree(html_tree)</span>
<div class="specs">
<pre>remove_unlikely_tree(<a href="#t:html_tree/0">html_tree</a>) :: <a href="#t:html_tree/0">html_tree</a></pre>
</div>
</div>
<section class="docstring">
<p>Remove unlikely html tree</p>
</section>
</div>
<div class="detail" id="transform_misused_div_to_p/1">
<div class="detail-header">
<a href="#transform_misused_div_to_p/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">transform_misused_div_to_p(content)</span>
<div class="specs">
<pre>transform_misused_div_to_p(<a href="#t:html_tree/0">html_tree</a>) :: <a href="#t:html_tree/0">html_tree</a></pre>
</div>
</div>
<section class="docstring">
<p>Transform misused divs <div>s that do not contain other block elements into <p>s</p>
</section>
</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>