mdka 1.6.9

HTML to Markdown converter
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

//! HTML to Markdown converter - Lightweight library written in Rust.

mod elements;
mod nodes;
mod utils;

use nodes::{node::root_node_md, utils::parse_html};
use utils::file::{read_from_filepath, write_to_filepath};

#[cfg(feature = "pyo3")]
pub mod python_bindings;

#[cfg(feature = "napi")]
pub mod nodejs_bindings;

/// Convert HTML to Markdown
///
/// ```
/// use mdka::from_html;
///
/// let html_text = r#"
/// <h1>heading 1</h1>
/// <p>Hello, world.</p>"#;
/// let expect = "# heading 1\n\nHello, world.\n\n";
///
/// let ret = from_html(html_text);
/// assert_eq!(ret, expect);
/// ```
///
pub fn from_html(html_text: &str) -> String {
    let dom = parse_html(html_text);
    root_node_md(&dom.document, None::<usize>)
}

/// Convert HTML to Markdown
///
/// ```
/// use mdka::from_file;
///
/// let html_filepath = "tests/fixtures/simple-01.html";
/// let expect = "# heading 1\n\nHello, world.\n\n";
///
/// let ret = from_file(html_filepath).expect("Failed to read");
/// assert_eq!(ret.as_str(), expect);
/// ```
///
pub fn from_file(html_filepath: &str) -> Result<String, String> {
    let html_text = read_from_filepath(html_filepath)
        .expect(format!("Failed to read: {}", html_filepath).as_str());
    Ok(from_html(html_text.as_str()))
}

/// Convert HTML to Markdown
///
/// ```
/// use mdka::from_html_to_file;
///
/// let html_text = r#"
/// <h1>heading 1</h1>
/// <p>Hello, world.</p>"#;
/// let markdown_filepath = "tests/tmp/from_html_file_doc_test_result.html";
/// let expect = "# heading 1\n\nHello, world.\n\n";
///
/// let ret = from_html_to_file(html_text, markdown_filepath, true).expect("Failed to write");
/// let markdown_file_content = std::fs::read_to_string(markdown_filepath).expect("Failed to read from markdown filepath");
/// assert_eq!(expect, markdown_file_content);
/// ```
///
pub fn from_html_to_file(
    html_text: &str,
    markdown_filepath: &str,
    overwrites: bool,
) -> Result<(), String> {
    let md = from_html(html_text);
    write_to_filepath(md.as_str(), markdown_filepath, overwrites)
}

/// Convert HTML to Markdown
///
/// ```
/// use mdka::from_file_to_file;
///
/// let html_filepath = "tests/fixtures/simple-01.html";
/// let markdown_filepath = "tests/tmp/from_html_file_doc_test_result.html";
/// let expect = "# heading 1\n\nHello, world.\n\n";
///
/// let ret = from_file_to_file(html_filepath, markdown_filepath, true).expect("Failed to write");
/// let markdown_file_content = std::fs::read_to_string(markdown_filepath).expect("Failed to read from markdown filepath");
/// assert_eq!(expect, markdown_file_content);
/// ```
///
pub fn from_file_to_file(
    html_filepath: &str,
    markdown_filepath: &str,
    overwrites: bool,
) -> Result<(), String> {
    let html = read_from_filepath(html_filepath)
        .expect(format!("Failed to read: {}", html_filepath).as_str());
    from_html_to_file(html.as_str(), markdown_filepath, overwrites)
}