Skip to content

feat: add artifacts_dir parameter to export_to_markdown and export_to_html #552

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

Open
olijacklu wants to merge 3 commits into
base: main
Choose a base branch
from
+24 −2
Open

feat: add artifacts_dir parameter to export_to_markdown and export_to_html #552

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c076dc0
feat: add artifacts_dir parameter to export_to_markdown and export_to…
Mar 16, 2026
1f8a978
Merge branch 'main' into feature/artifacts-dir-export
olijacklu Mar 22, 2026
99ccd9c
feat: rename artifacts_dir to image_dir for consistency
Mar 27, 2026
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
26 changes: 24 additions & 2 deletions docling_core/types/doc/document.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5794,6 +5794,7 @@ def export_to_markdown(
include_annotations: bool = True,
mark_annotations: bool = False,
compact_tables: bool = False,
image_dir: Optional[Union[str, Path]] = None,
traverse_pictures: bool = False,
*,
use_legacy_annotations: Optional[bool] = None, # deprecated
Expand Down Expand Up @@ -5847,6 +5848,10 @@ def export_to_markdown(
:type mark_annotations: bool = False
:param compact_tables: bool: Whether to use compact table format without column padding. (Default value = False).
:type compact_tables: bool = False
:param image_dir: Optional directory path where images will be saved when using
ImageRefMode.REFERENCED. If provided, images are automatically saved to this
directory and referenced in the markdown output. (Default value = None).
:type image_dir: Optional[Union[str, Path]] = None
:param traverse_pictures: bool: Whether to traverse into picture items and
serialize their text children. Must be set to True for scanned/image-based
PDFs processed with full-page OCR, where the layout model places all OCR
Expand Down Expand Up @@ -5877,8 +5882,16 @@ def export_to_markdown(
DeprecationWarning,
)

# Handle image saving when image_dir is provided
doc = self
if image_dir is not None and image_mode == ImageRefMode.REFERENCED:
doc = self._with_pictures_refs(
image_dir=Path(image_dir),
page_no=page_no,
)

serializer = MarkdownDocSerializer(
doc=self,
doc=doc,
params=MarkdownParams(
labels=my_labels,
layers=my_layers,
Expand Down Expand Up @@ -6078,6 +6091,7 @@ def export_to_html(
included_content_layers: Optional[set[ContentLayer]] = None,
split_page_view: bool = False,
include_annotations: bool = True,
image_dir: Optional[Union[str, Path]] = None,
) -> str:
r"""Serialize to HTML."""
from docling_core.transforms.serializer.html import (
Expand Down Expand Up @@ -6111,8 +6125,16 @@ def export_to_html(
if html_head == "null":
params.html_head = None

# Handle image saving when image_dir is provided
doc = self
if image_dir is not None and image_mode == ImageRefMode.REFERENCED:
doc = self._with_pictures_refs(
image_dir=Path(image_dir),
page_no=page_no,
)

serializer = HTMLDocSerializer(
doc=self,
doc=doc,
params=params,
)
ser_res = serializer.serialize()
Expand Down
Loading