Skip to content

fix: expose escape_html param to DoclingDocument md serialization #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 22, 2025
+6 −0
Merged

fix: expose escape_html param to DoclingDocument md serialization #388

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docling_core/types/doc/document.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4386,6 +4386,7 @@ def save_as_markdown(
to_element: int = sys.maxsize,
labels: Optional[set[DocItemLabel]] = None,
strict_text: bool = False,
escape_html: bool = True,
escaping_underscores: bool = True,
image_placeholder: str = "<!-- image -->",
image_mode: ImageRefMode = ImageRefMode.PLACEHOLDER,
Expand Down Expand Up @@ -4414,6 +4415,7 @@ def save_as_markdown(
to_element=to_element,
labels=labels,
strict_text=strict_text,
escape_html=escape_html,
escape_underscores=escaping_underscores,
image_placeholder=image_placeholder,
image_mode=image_mode,
Expand All @@ -4435,6 +4437,7 @@ def export_to_markdown( # noqa: C901
to_element: int = sys.maxsize,
labels: Optional[set[DocItemLabel]] = None,
strict_text: bool = False,
escape_html: bool = True,
escape_underscores: bool = True,
image_placeholder: str = "<!-- image -->",
enable_chart_tables: bool = True,
Expand Down Expand Up @@ -4465,6 +4468,8 @@ def export_to_markdown( # noqa: C901
:type labels: Optional[set[DocItemLabel]] = None
:param strict_text: Deprecated.
:type strict_text: bool = False
:param escape_html: bool: Whether to escape HTML reserved characters in the
text content of the document. (Default value = True).
:param escape_underscores: bool: Whether to escape underscores in the
text content of the document. (Default value = True).
:type escape_underscores: bool = True
Expand Down Expand Up @@ -4511,6 +4516,7 @@ def export_to_markdown( # noqa: C901
pages={page_no} if page_no is not None else None,
start_idx=from_element,
stop_idx=to_element,
escape_html=escape_html,
escape_underscores=escape_underscores,
image_placeholder=image_placeholder,
enable_chart_tables=enable_chart_tables,
Expand Down
Loading