decruft 0.1.3

Extract clean, readable content from web pages
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

#![deny(
    clippy::unwrap_used,
    clippy::panic,
    clippy::dbg_macro,
    clippy::todo,
    clippy::print_stdout,
    clippy::print_stderr
)]

//! # decruft
//!
//! Extract clean, readable content from web pages.
//!
//! Given a noisy HTML page (ads, navigation, sidebars, popups, cookie banners...),
//! decruft extracts the main content and metadata.
//!
//! ## Quick start
//!
//! ```
//! use decruft::{parse, DecruftOptions};
//!
//! let html = r#"<html>
//!   <head><title>My Post - Blog</title></head>
//!   <body>
//!     <nav><a href="/">Home</a></nav>
//!     <article><h1>My Post</h1><p>The content.</p></article>
//!     <footer>Copyright 2025</footer>
//!   </body>
//! </html>"#;
//!
//! let result = parse(html, &DecruftOptions::default());
//! assert!(result.content.contains("The content."));
//! assert!(!result.content.contains("Copyright"));
//! ```
//!
//! Or even simpler with [`parse_with_defaults`]:
//!
//! ```
//! let html = "<html><body><article><p>Hello</p></article></body></html>";
//! let result = decruft::parse_with_defaults(html);
//! assert!(result.content.contains("Hello"));
//! ```

pub(crate) mod callouts;
pub(crate) mod cleanup;
pub(crate) mod code_blocks;
pub(crate) mod content;
mod decruft;
pub(crate) mod dom;
pub(crate) mod extractors;
pub(crate) mod footnotes;
pub(crate) mod http;
pub(crate) mod math;
pub(crate) mod metadata;
pub(crate) mod metadata_block;
pub(crate) mod noscript;
pub(crate) mod patterns;
pub(crate) mod schema_org;
pub(crate) mod scorer;
pub(crate) mod selectors;
pub(crate) mod standardize;
pub(crate) mod streaming_ssr;
pub(crate) mod types;

pub use decruft::parse;
pub use dom::strip_html_tags;
pub use types::{DebugInfo, DecruftOptions, DecruftResult, MetaTag, Removal};

/// Parse HTML with default options.
///
/// Equivalent to `parse(html, &DecruftOptions::default())`.
///
/// # Examples
///
/// ```
/// let html = "<html><body><article><p>Hello</p></article></body></html>";
/// let result = decruft::parse_with_defaults(html);
/// assert!(result.content.contains("Hello"));
/// ```
#[must_use]
pub fn parse_with_defaults(html: &str) -> DecruftResult {
    parse(html, &DecruftOptions::default())
}