Struct HtmlToMarkdown 

pub struct HtmlToMarkdown { /* private fields */ }

The html-to-markdown converter.

Example

use htmd::{Element, HtmlToMarkdown};

// One-liner
let md = HtmlToMarkdown::new().convert("<h1>Hello</h1>").unwrap();
assert_eq!("# Hello", md);

// Or use the builder pattern
let converter = HtmlToMarkdown::builder()
    .skip_tags(vec!["img"])
    .build();
let md = converter.convert("<img src=\"https://example.com\">").unwrap();
// img is ignored
assert_eq!("", md);

Implementations

impl HtmlToMarkdown

pub fn new() -> Self

Create a new converter.

pub fn builder() -> HtmlToMarkdownBuilder

Create a new HtmlToMarkdownBuilder.

pub fn html_to_tree(&self, html: &str) -> Result<Rc<Node>>

Convert HTML to a DOM tree.

pub fn tree_to_markdown(&self, tree: &Rc<Node>) -> String

Convert a DOM tree to Markdown. For convenience, Node is re-exported; simply use htmd::Node; to access this type.

pub fn convert(&self, html: &str) -> Result<String>

Convert HTML to Markdown.

Trait Implementations

impl Default for HtmlToMarkdown

fn default() -> Self

Returns the “default value” for a type.