update documentation

niklak · Feb 22, 2025 · bc23d81 · bc23d81
1 parent 1725fbb
commit bc23d81
Show file tree

Hide file tree

Showing 3 changed files with 99 additions and 4 deletions.
diff --git a/Examples.md b/Examples.md
@@ -755,4 +755,52 @@ assert_eq!(selected_count, total_links);
 let found_count = main_node.find(&["div", "a"]).len();
 assert_eq!(found_count, total_links);
 ```
+</details>
+
+
+<details>
+    <summary><b>Serializing a document to Markdown</b></summary>
+
+
+```rust
+#[cfg(feature = "markdown")]
+{
+    use dom_query::Document;
+
+    let contents = "
+    <style>p {color: blue;}</style>
+    <p>I really like using <b>Markdown</b>.</p>
+
+    <p>I think I'll use it to format all of my documents from now on.</p>";
+
+    let expected = "I really like using **Markdown**\\.\n\n\
+    I think I'll use it to format all of my documents from now on\\.";
+
+    let doc = Document::from(contents);
+    // Passing `None` into md allows to use default skip tags, which are: 
+    // `["script", "style", "meta", "head"]`.
+    let got = doc.md(None);
+    assert_eq!(got.as_ref(), expected);
+
+    // If you need the full text content of the elements, pass `Some(&vec![])` to `md`.
+    // If you pass content like the example below to `Document::from`,
+    // `html5ever` will create a `<head>` element and place your `<style>` element inside it.
+    // To preserve the original order, use `Document::fragment`.
+
+    let contents = "<style>p {color: blue;}</style>\
+    <div><h1>Content Heading<h1></div>\
+    <p>I really like using Markdown.</p>\
+    <p>I think I'll use it to format all of my documents from now on.</p>";
+
+    let expected = "p \\{color: blue;\\}\n\
+    I really like using Markdown\\.\n\n\
+    I think I'll use it to format all of my documents from now on\\.";
+
+    let doc = Document::fragment(contents);
+    let got = doc.md(Some(&["div"]));
+    assert_eq!(got.as_ref(), expected);
+}
+
+```
+
 </details>
diff --git a/README.md b/README.md
@@ -777,6 +777,52 @@ assert_eq!(found_count, total_links);
 ```
 </details>
 
+
+<details>
+    <summary><b>Serializing a document to Markdown</b></summary>
+
+*This example requires `markdown` feature.*
+
+```rust
+use dom_query::Document;
+
+let contents = "
+<style>p {color: blue;}</style>
+<p>I really like using <b>Markdown</b>.</p>
+
+<p>I think I'll use it to format all of my documents from now on.</p>";
+
+let expected = "I really like using **Markdown**\\.\n\n\
+I think I'll use it to format all of my documents from now on\\.";
+
+let doc = Document::from(contents);
+// Passing `None` into md allows to use default skip tags, which are: 
+// `["script", "style", "meta", "head"]`.
+let got = doc.md(None);
+assert_eq!(got.as_ref(), expected);
+
+// If you need the full text content of the elements, pass `Some(&vec![])` to `md`.
+// If you pass content like the example below to `Document::from`,
+// `html5ever` will create a `<head>` element and place your `<style>` element inside it.
+// To preserve the original order, use `Document::fragment`.
+
+let contents = "<style>p {color: blue;}</style>\
+<div><h1>Content Heading<h1></div>\
+<p>I really like using Markdown.</p>\
+<p>I think I'll use it to format all of my documents from now on.</p>";
+
+let expected = "p \\{color: blue;\\}\n\
+I really like using Markdown\\.\n\n\
+I think I'll use it to format all of my documents from now on\\.";
+
+let doc = Document::fragment(contents);
+let got = doc.md(Some(&["div"]));
+assert_eq!(got.as_ref(), expected);
+
+```
+
+</details>
+
 - **[more examples](./examples/)**
 - **[dom_query by example](https://niklak.github.io/dom_query_by_example/)**
 
@@ -794,8 +840,9 @@ assert_eq!(found_count, total_links);
 ## Crate features
 
 - `hashbrown` — optional, standard hashmaps and hashsets will be replaced `hashbrown` hashmaps and hashsets;
-- `atomic` — options, switches `NodeData` from using `StrTendril` to `Tendril<tendril::fmt::UTF8, tendril::Atomic>`. 
+- `atomic` — optional, switches `NodeData` from using `StrTendril` to `Tendril<tendril::fmt::UTF8, tendril::Atomic>`. 
 This allows `NodeData` and all ascending structures, including `Document`, to implement the `Send` trait;
+- `markdown` — optional, enables the `Document::md` and `NodeRef::md` methods, allowing serialization of a document or node to `Markdown` text. 
 
 ## Possible issues
 * [wasm32 compilation](https://niklak.github.io/dom_query_by_example/WASM32-compilation.html)

diff --git a/src/serializing/md.rs b/src/serializing/md.rs
@@ -908,19 +908,19 @@ R 2, *C 1* R 2, *C 2*";
         // By default, formatter will skip ["script", "style", "meta", "head"]
         let contents = "
         <style>p {color: blue;}</style>
-        <p>I really like using Markdown.</p>
+        <p>I really like using <b>Markdown</b>.</p>
 
         <p>I think I'll use it to format all of my documents from now on.</p>";
 
-        let expected = "I really like using Markdown\\.\n\n\
+        let expected = "I really like using **Markdown**\\.\n\n\
         I think I'll use it to format all of my documents from now on\\.";
 
         html_2md_compare(contents, expected);
     }
 
     #[test]
     fn test_skip_tags() {
-        // If you need all text content of the elements, you need to pass Some(&vec![]) to `format_md`, or `MDFormatter::new`.
+        // If you need all text content of the elements, you need to pass Some(&vec![]) to `md`.
         // If you pass a structure like this into `Document::from`, the html5ever will create html > head > style.
         // If you want to preserve order use `Document::fragment`.
         let contents = "<style>p {color: blue;}</style>\