fix: Escaping underscore characters in md export (#57)

* Escaping underscore characters in md export Signed-off-by: Maksym Lysak <[email protected]> * Run pre-commits Signed-off-by: Maksym Lysak <[email protected]> --------- Signed-off-by: Maksym Lysak <[email protected]> Co-authored-by: Maksym Lysak <[email protected]>
DS4SD · Oct 25, 2024 · c344d0f · c344d0f
1 parent b9b3c60
commit c344d0f
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docling_core/types/doc/document.py b/docling_core/types/doc/document.py
@@ -1291,6 +1291,18 @@ def export_to_markdown(  # noqa: C901
         mdtext = re.sub(
             r"\n\n\n+", "\n\n", mdtext
         )  # remove cases of double or more empty lines.
+
+        # Our export markdown doesn't contain any emphasis styling:
+        # Bold, Italic, or Bold-Italic
+        # Hence, any underscore that we print into Markdown is coming from document text
+        # That means we need to escape it, to properly reflect content in the markdown
+        def escape_underscores(text):
+            # Replace "_" with "\_" only if it's not already escaped
+            escaped_text = re.sub(r"(?<!\\)_", r"\_", text)
+            return escaped_text
+
+        mdtext = escape_underscores(mdtext)
+
         return mdtext
 
     def export_to_text(  # noqa: C901