Packages

A fork of the Readability library for extracting and curating articles.

Current section

Files

Jump to
readability2 doc dist sidebar_items-DEB54610.js
Raw

doc/dist/sidebar_items-DEB54610.js

sidebarNodes={"extras":[{"group":"","headers":[{"anchor":"modules","id":"Modules"}],"id":"api-reference","title":"API Reference"}],"modules":[{"group":"","id":"Readability","nodeGroups":[{"key":"types","name":"Types","nodes":[{"anchor":"t:headers/0","id":"headers/0","title":"headers()"},{"anchor":"t:html_tree/0","id":"html_tree/0","title":"html_tree()"},{"anchor":"t:options/0","id":"options/0","title":"options()"},{"anchor":"t:raw_html/0","id":"raw_html/0","title":"raw_html()"},{"anchor":"t:url/0","id":"url/0","title":"url()"}]},{"key":"functions","name":"Functions","nodes":[{"anchor":"article/2","id":"article/2","title":"article(raw_html, opts \\\\ [])"},{"anchor":"authors/1","id":"authors/1","title":"authors(html)"},{"anchor":"default_options/0","id":"default_options/0","title":"default_options()"},{"anchor":"is_response_markup/1","id":"is_response_markup/1","title":"is_response_markup(headers)"},{"anchor":"mime/1","id":"mime/1","title":"mime(headers \\\\ [])"},{"anchor":"parse/1","id":"parse/1","title":"parse(raw_html)"},{"anchor":"raw_html/1","id":"raw_html/1","title":"raw_html(html_tree)"},{"anchor":"readable_html/1","id":"readable_html/1","title":"readable_html(html_tree)"},{"anchor":"readable_text/1","id":"readable_text/1","title":"readable_text(html_tree)"},{"anchor":"regexes/1","id":"regexes/1","title":"regexes(key)"},{"anchor":"summarize/2","id":"summarize/2","title":"summarize(url, opts \\\\ [])"},{"anchor":"title/1","id":"title/1","title":"title(raw_html)"}]}],"sections":[{"anchor":"module-example","id":"Example"}],"title":"Readability"},{"group":"","id":"Readability.ArticleBuilder","nodeGroups":[{"key":"types","name":"Types","nodes":[{"anchor":"t:html_tree/0","id":"html_tree/0","title":"html_tree()"},{"anchor":"t:options/0","id":"options/0","title":"options()"}]},{"key":"functions","name":"Functions","nodes":[{"anchor":"build/2","id":"build/2","title":"build(html_tree, opts)"}]}],"sections":[],"title":"Readability.ArticleBuilder"},{"group":"","id":"Readability.AuthorFinder","nodeGroups":[{"key":"types","name":"Types","nodes":[{"anchor":"t:html_tree/0","id":"html_tree/0","title":"html_tree()"}]},{"key":"functions","name":"Functions","nodes":[{"anchor":"find/1","id":"find/1","title":"find(html_tree)"},{"anchor":"find_by_meta_tag/1","id":"find_by_meta_tag/1","title":"find_by_meta_tag(html_tree)"}]}],"sections":[],"title":"Readability.AuthorFinder"},{"group":"","id":"Readability.Candidate","sections":[],"title":"Readability.Candidate"},{"group":"","id":"Readability.Candidate.Cleaner","nodeGroups":[{"key":"types","name":"Types","nodes":[{"anchor":"t:html_tree/0","id":"html_tree/0","title":"html_tree()"}]},{"key":"functions","name":"Functions","nodes":[{"anchor":"remove_unlikely_tree/1","id":"remove_unlikely_tree/1","title":"remove_unlikely_tree(html_tree)"},{"anchor":"transform_misused_div_to_p/1","id":"transform_misused_div_to_p/1","title":"transform_misused_div_to_p(content)"}]}],"sections":[],"title":"Readability.Candidate.Cleaner"},{"group":"","id":"Readability.Candidate.Scoring","nodeGroups":[{"key":"types","name":"Types","nodes":[{"anchor":"t:html_tree/0","id":"html_tree/0","title":"html_tree()"},{"anchor":"t:options/0","id":"options/0","title":"options()"}]},{"key":"functions","name":"Functions","nodes":[{"anchor":"calc_link_density/1","id":"calc_link_density/1","title":"calc_link_density(html_tree)"},{"anchor":"calc_score/2","id":"calc_score/2","title":"calc_score(html_tree, opts \\\\ [])"},{"anchor":"class_weight/1","id":"class_weight/1","title":"class_weight(attrs)"}]}],"sections":[],"title":"Readability.Candidate.Scoring"},{"group":"","id":"Readability.CandidateFinder","nodeGroups":[{"key":"types","name":"Types","nodes":[{"anchor":"t:html_tree/0","id":"html_tree/0","title":"html_tree()"},{"anchor":"t:options/0","id":"options/0","title":"options()"}]},{"key":"functions","name":"Functions","nodes":[{"anchor":"find/3","id":"find/3","title":"find(text, opts \\\\ [], tree_depth \\\\ 0)"},{"anchor":"find_best_candidate/1","id":"find_best_candidate/1","title":"find_best_candidate(candidates)"}]}],"sections":[],"title":"Readability.CandidateFinder"},{"group":"","id":"Readability.Helper","nodeGroups":[{"key":"types","name":"Types","nodes":[{"anchor":"t:html_tree/0","id":"html_tree/0","title":"html_tree()"}]},{"key":"functions","name":"Functions","nodes":[{"anchor":"candidate_tag?/1","id":"candidate_tag?/1","title":"candidate_tag?(html_tree)"},{"anchor":"change_tag/3","id":"change_tag/3","title":"change_tag(content, selector, tag)"},{"anchor":"normalize/2","id":"normalize/2","title":"normalize(raw_html, opts \\\\ [])"},{"anchor":"remove_attrs/2","id":"remove_attrs/2","title":"remove_attrs(content, t_attrs)"},{"anchor":"remove_tag/2","id":"remove_tag/2","title":"remove_tag(content, fun)"},{"anchor":"text_length/1","id":"text_length/1","title":"text_length(html_tree)"}]}],"sections":[],"title":"Readability.Helper"},{"group":"","id":"Readability.Sanitizer","nodeGroups":[{"key":"types","name":"Types","nodes":[{"anchor":"t:html_tree/0","id":"html_tree/0","title":"html_tree()"}]},{"key":"functions","name":"Functions","nodes":[{"anchor":"sanitize/3","id":"sanitize/3","title":"sanitize(html_tree, candidates, opts \\\\ [])"}]}],"sections":[],"title":"Readability.Sanitizer"},{"group":"","id":"Readability.Summary","sections":[],"title":"Readability.Summary"},{"group":"","id":"Readability.TitleFinder","nodeGroups":[{"key":"types","name":"Types","nodes":[{"anchor":"t:html_tree/0","id":"html_tree/0","title":"html_tree()"}]},{"key":"functions","name":"Functions","nodes":[{"anchor":"h_tag_title/2","id":"h_tag_title/2","title":"h_tag_title(html_tree, selector \\\\ \"h1, h2, h3\")"},{"anchor":"og_title/1","id":"og_title/1","title":"og_title(html_tree)"},{"anchor":"tag_title/1","id":"tag_title/1","title":"tag_title(html_tree)"},{"anchor":"title/1","id":"title/1","title":"title(html_tree)"}]}],"sections":[],"title":"Readability.TitleFinder"}],"tasks":[]}