mdream 1.6.0

Fastest HTML-to-Markdown converter. Zero dependencies, streaming support.
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

# mdream

Fastest HTML-to-Markdown converter. Zero dependencies, streaming support.

## Install

```sh
cargo add mdream
```

Or as a CLI:

```sh
cargo install mdream
```

## Usage

### Library

```rust
use mdream::{html_to_html, html_to_markdown, types::HTMLToMarkdownOptions};

let html = "<h1>Hello</h1><p>World</p>";
let md = html_to_markdown(html, HTMLToMarkdownOptions::default());
assert_eq!(md, "# Hello\n\nWorld");

let html_output = html_to_html(
    "<h1>Hello</h1><p>World</p>",
    HTMLToMarkdownOptions::default(),
);
assert_eq!(html_output, "<h1 id=\"hello\">Hello</h1><p>World</p>");
```

### Streaming

```rust
use mdream::MarkdownStreamProcessor;
use mdream::types::HTMLToMarkdownOptions;

let mut stream = MarkdownStreamProcessor::new(HTMLToMarkdownOptions::default());
let chunk1 = stream.process_chunk("<h1>Hello</h1>");
let chunk2 = stream.process_chunk("<p>World</p>");
let remaining = stream.finish();
```

### CLI

```sh
curl -s https://example.com | mdream

# HTML output
curl -s https://example.com | mdream --format html
```

## License

MIT