Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/letmutex/htmd
A turndown.js inspired HTML to Markdown converter for Rust
https://github.com/letmutex/htmd
Last synced: 4 months ago
JSON representation
A turndown.js inspired HTML to Markdown converter for Rust
- Host: GitHub
- URL: https://github.com/letmutex/htmd
- Owner: letmutex
- License: apache-2.0
- Created: 2024-06-16T07:55:12.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-12T06:07:43.000Z (7 months ago)
- Last Synced: 2024-09-14T12:18:40.336Z (5 months ago)
- Language: Rust
- Size: 313 KB
- Stars: 300
- Watchers: 5
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# htmd
[](https://crates.io/crates/htmd)
An HTML to Markdown converter for Rust, inspired by [turndown.js](https://github.com/mixmark-io/turndown).
### Features
- Rich options, same as turndown.js
- Reliable, it passes [all test cases](https://github.com/mixmark-io/turndown/blob/master/test/index.html) of turndown.js
- Minimum dependencies, it uses only [html5ever](https://github.com/servo/html5ever)
- Fast, it takes ~70ms to convert a 1.37MB Wikipedia page on an i5 7th gen CPU (See [Bench README](benches/README.md))
*Looking for the cli tool? Try [htmd-cli](https://github.com/letmutex/htmd-cli) now!*
# Usages
Add the dependency
```toml
htmd = "0.1"
```
### Basic
```rust
fn main() {
assert_eq!("# Heading", htmd::convert("
Heading
").unwrap());
}
```
### Skip tags
```rust
use htmd::HtmlToMarkdown;
let converter = HtmlToMarkdown::builder()
.skip_tags(vec!["script", "style"])
.build();
assert_eq!("", converter.convert("let x = 0;").unwrap());
```
### Options
```rust
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("
Heading
").unwrap());
```
### Custom tag handlers
```rust
use htmd::HtmlToMarkdown;
let converter = HtmlToMarkdown::builder()
.add_handler(vec!["svg"], |_: Element| Some("[Svg Image]".to_string()))
.build();
assert_eq!("[Svg Image]", converter.convert("").unwrap());
```
### Multithreading
You can safely share `HtmlToMarkdown` between multiple threads when only using built-in tag handlers.
```rust
let converter = Arc::new(HtmlToMarkdown::new());
for _ in 0..10 {
let converter_clone = converter.clone();
let handle = std::thread::spawn(move || {
let md = converter_clone.convert("
Hello
").unwrap();
});
}
```
If you have custom tag handlers that are not stateless, you likely need a thread-safe mechanism. See [AnchorElementHandler](./src/element_handler/anchor.rs) for example.
# Credits
- [turndown.js](https://github.com/mixmark-io/turndown)
- [html5ever](https://github.com/servo/html5ever)
# License
```
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://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.
```