docling-project/docling

Add image_dir parameter to export_to_markdown for automatic image saving

Open

#3.094 geöffnet am 9. März 2026

Auf GitHub ansehen
 (3 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Python (4.140 Forks)batch import
docling-documentenhancementgood first issue

Repository-Metriken

Stars
 (59.751 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 7T 5h) (93 gemergte PRs in 30 T)

Beschreibung

Problem

When using ImageRefMode.REFERENCED, users must manually:

  1. Iterate through all picture elements
  2. Save each image to disk
  3. Update the URI for each element
  4. Then call export_to_markdown()

Proposed Solution

Add optional image_dir and image_path_prefix parameters to export methods:

markdown = doc.export_to_markdown(
    image_mode=ImageRefMode.REFERENCED,
    image_dir=Path("./output/images"),
    image_path_prefix="images/"  # relative path in markdown output
)

When image_dir is provided:

  • Automatically save images to that directory
  • Generate sequential filenames (e.g. image_001.png)
  • Use image_path_prefix in the markdown output

Affected Methods

  • DoclingDocument.export_to_markdown()
  • PictureItem.export_to_markdown()
  • Potentially HTML export methods too

Would this be an interesting feature to have? Happy to submit a PR.

(PS: Keep up the great work!!)

Contributor Guide

Research-Richtung
Implementieren Sie den image dir Parameter, indem Sie die Bildspeicherlogik in export to markdown und verwandte Methoden einfügen.
Tech Stack
python
Domain
backend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65