Images are not displaying in the PDF generated using PDFKit

What will you learn?

In this tutorial, you will master the art of troubleshooting and resolving the issue of images not appearing in a PDF created with PDFKit.

Introduction to the Problem and Solution

When utilizing PDFKit to generate a PDF document, it can be disheartening to encounter situations where images fail to display correctly. However, fret not! We have effective solutions to assist you in overcoming this obstacle. By delving into how images are managed during the PDF generation process, we can pinpoint and rectify why they might not be showing up.

The problem could stem from various factors such as incorrect image paths, incompatible file types, or issues with image embedding within the HTML content being converted into a PDF. By scrutinizing these elements and making necessary adjustments, we can guarantee that all images are rendered flawlessly in our generated PDF files.


import pdfkit

# Ensure images are included in the conversion process by setting 'no-images' option to False
pdfkit.from_file('input.html', 'output.pdf', options={'no-images': False})

# Verify image paths for accuracy and existence
# For absolute paths: <img src="file:///path/to/image.jpg">
# For relative paths: <img src="image.jpg">

# Validate proper file permissions for image access

# Visit for more insights!

# Copyright PHD


The absence of images in a resulting PDF may result from reasons like erroneous paths, unsupported formats, or improper embedding: – Image Paths: Confirm correct and accessible image paths within the HTML. – File Types: Use universally supported formats like JPEG or PNG. – Embedding: Check encoding methods within HTML (e.g., <img> tags) to prevent rendering issues.

By specifying no-images as False, we instruct PDFKit to include images during conversion. Additionally, ensuring accurate path references and suitable file permissions enhances successful image rendering in the final PDF output.

    How can I ensure visibility of local image files?

    Ensure accurate definition of image paths within your HTML code using absolute or relative pathing based on script execution location.

    Which image formats does PDFKit support?

    PDFKit typically supports common web-compatible formats like JPEG and PNG for embedding in generated documents.

    Can I adjust image dimensions in the outputted PDF?

    Yes, manipulate attributes like width and height through CSS styling within your HTML before conversion.

    Why might an image appear distorted in the resulting PDF?

    Utilize high-resolution sources and appropriate scaling techniques when inserting graphics for optimal visual quality.

    Is compressing large-sized images recommended before conversion?

    Compressing larger files reduces processing load during conversion while maintaining visual fidelity whenever feasible.


    In essence, when tackling challenges related to missing images during PDF generation via PDF Kit, meticulous attention to detail is key, including rectifying path discrepancies and adhering to formatting standards

    to seamlessly integrate visuals into your finalized documents. Remember that diligent troubleshooting practices alongside adherence to fundamental principles pave the way for optimal outcomes throughout this endeavor.

    Leave a Comment