lectito 0.2.0

Article extraction and readability parsing for Lectito.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//! Extract readable article content from HTML.
//!
//! The crate does not fetch pages. Pass HTML from a crawler, browser, cache, or
//! fixture, plus an optional base URL for resolving relative links.
//!
//! Use [`extract`] for normal application code. Use
//! [`extract_with_diagnostics`] when debugging root selection, cleanup, or site
//! profiles.
//!
//! ```no_run
//! use lectito::{extract, ReadabilityOptions};
//!
//! # fn main() -> Result<(), lectito::Error> {
//! # let html = "<article><p>Article text.</p></article>";
//! let options = ReadabilityOptions::default();
//! let article = extract(html, Some("https://example.com/post"), &options)?;
//! if let Some(article) = article {
//!     println!("{}", article.text_content);
//! }
//! # Ok::<(), lectito::Error>(())
//! # }
//! ```

mod cleanup;
mod config;
mod diagnostics;
mod dom;
mod error;
mod extract;
mod json_schema;
mod markdown;
mod metadata;
mod normalize;
mod patterns;
mod readable;
mod recovery;
mod regexes;
mod rules;
mod scoring;
mod serialize;
mod shared;

pub use config::{Article, MarkdownOptions, MediaRetention, ReadabilityOptions, ReadableOptions};
pub use diagnostics::{
    AttemptDiagnostic, CandidateDiagnostic, CandidateSelection, CleanupDiagnostic, ContentSelectorDiagnostic,
    ExtractionDiagnostics, ExtractionOutcome, ExtractionReport, FlagDiagnostic, NodeDiagnostic, RecoveryDiagnostic,
};
pub use error::{Error, Result};
pub use extract::{clean_article_html, extract, extract_with_diagnostics};
pub use markdown::{html_to_markdown, markdown_to_html, markdown_with_toml_frontmatter};
pub use readable::is_probably_readable;
pub use shared::escape_html;