An HTML to Markdown converter for Rust, inspired by turndown.js.
- Rich options, same as turndown.js
- Reliable, it passes all test cases of turndown.js
- Minimum dependencies, it uses only html5ever
- Fast, it takes less than 200ms to convert a ~1.4MB Wikipedia page on an i5 7th gen CPU
Add the dependency
htmd = "0.1"use htmd::HtmlToMarkdown;
fn main() {
assert_eq!("# Heading", HtmlToMarkdown::new().convert("<h1>Heading</h1>").unwrap());
}use htmd::HtmlToMarkdown;
let converter = HtmlToMarkdown::builder()
.skip_tags(vec!["script", "style"])
.build();
assert_eq!("", converter.convert("<script>let x = 0;</script>").unwrap());use htmd::{options::Options, HtmlToMarkdown};
let converter = HtmlToMarkdown::builder()
.options(Options {
heading_style: htmd::options::HeadingStyle::Setex,
..Default::default()
})
.build();
assert_eq!("Heading\n=======", converter.convert("<h1>Heading</h1>").unwrap());use htmd::HtmlToMarkdown;
let converter = HtmlToMarkdown::builder()
.add_handler(vec!["svg"], |_: Element| Some("[Svg Image]".to_string()))
.build();
assert_eq!("[Svg Image]", converter.convert("<svg></svg>").unwrap());Copyright 2024 letmutex
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http:https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.