html-to-markdown-rs 3.4.0

High-performance HTML to Markdown converter using the astral-tl parser. Part of the Kreuzberg ecosystem.
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

#![allow(missing_docs)]

fn convert(html: &str) -> String {
    html_to_markdown_rs::convert(html, None)
        .map(|r| r.content.unwrap_or_default())
        .expect("conversion should succeed")
}

// --- header ---

#[test]
fn test_h1_inside_header() {
    let html = "<header><h1>Title in header not exported???</h1></header>";
    let result = convert(html);
    assert_eq!(result, "# Title in header not exported???\n");
}

#[test]
fn test_paragraph_inside_header() {
    let html = "<header><p>Intro text</p></header>";
    let result = convert(html);
    assert_eq!(result, "Intro text\n");
}

#[test]
fn test_header_with_nested_elements() {
    let html = "<header><h1>Title</h1><p>Subtitle</p></header>";
    let result = convert(html);
    assert!(result.contains("# Title"), "Should contain h1: {result}");
    assert!(result.contains("Subtitle"), "Should contain paragraph: {result}");
}

// --- footer ---

#[test]
fn test_paragraph_inside_footer() {
    let html = "<footer><p>Footer content</p></footer>";
    let result = convert(html);
    assert_eq!(result, "Footer content\n");
}

// --- main ---

#[test]
fn test_h2_inside_main() {
    let html = "<main><h2>Main heading</h2></main>";
    let result = convert(html);
    assert_eq!(result, "## Main heading\n");
}

// --- article ---

#[test]
fn test_article_with_header_and_section() {
    let html = "<article><header><h1>Title</h1></header><section><p>Content here</p></section></article>";
    let result = convert(html);
    assert!(result.contains("# Title"), "Should contain heading: {result}");
    assert!(result.contains("Content here"), "Should contain content: {result}");
}

// --- section ---

#[test]
fn test_heading_inside_section() {
    let html = "<section><h2>Section Heading</h2><p>Section body</p></section>";
    let result = convert(html);
    assert!(result.contains("## Section Heading"), "Should contain h2: {result}");
    assert!(result.contains("Section body"), "Should contain body: {result}");
}

// --- nav ---

#[test]
fn test_nav_dropped_by_default() {
    // nav is dropped by default when remove_navigation is true (the default)
    let html = r#"<nav><a href="/home">Home</a><a href="/about">About</a></nav>"#;
    let result = convert(html);
    assert!(result.is_empty(), "nav should be dropped by default: '{result}'");
}

#[test]
fn test_nav_preserved_when_remove_navigation_disabled() {
    use html_to_markdown_rs::{ConversionOptions, PreprocessingOptions};
    let opts = ConversionOptions {
        preprocessing: PreprocessingOptions {
            remove_navigation: false,
            ..Default::default()
        },
        ..Default::default()
    };
    let html = r#"<nav><a href="/home">Home</a></nav>"#;
    let result = html_to_markdown_rs::convert(html, Some(opts))
        .map(|r| r.content.unwrap_or_default())
        .expect("conversion should succeed");
    assert!(
        result.contains("Home"),
        "nav should pass through when remove_navigation=false: '{result}'"
    );
}

// --- aside ---

#[test]
fn test_paragraph_inside_aside() {
    let html = "<aside><p>Side note</p></aside>";
    let result = convert(html);
    assert_eq!(result, "Side note\n");
}

// --- navigation-hinted header should still be dropped ---

#[test]
fn test_site_chrome_header_dropped() {
    // A <header> with class="site-header" is site chrome and should be removed
    let html = r#"<header class="site-header"><a href="/">Logo</a></header><p>Content</p>"#;
    let result = convert(html);
    assert!(
        !result.contains("Logo"),
        "site-chrome header should be dropped: '{result}'"
    );
    assert!(
        result.contains("Content"),
        "body content should be preserved: '{result}'"
    );
}

#[test]
fn test_header_with_role_navigation_dropped() {
    // A <header role="navigation"> is nav chrome and should be removed
    let html = r#"<header role="navigation"><a href="/">Home</a></header><p>Body</p>"#;
    let result = convert(html);
    assert!(
        !result.contains("Home"),
        "navigation header should be dropped: '{result}'"
    );
    assert!(result.contains("Body"), "body content should be preserved: '{result}'");
}