How to embed pdfs files in jupyter notebook on Github

ONLINECAST

2 min read

·

06-10-2024

8

0

Share

Embedding PDFs in Jupyter Notebooks on GitHub: A Seamless Way to Showcase Your Work

Sharing Jupyter notebooks with PDFs embedded directly within them can greatly enhance your presentations and reports on GitHub. This article explains how to achieve this seamlessly, enabling you to showcase your work in a more comprehensive and visually appealing manner.

The Problem: Static PDF Viewing on GitHub

GitHub's default display for Jupyter notebooks doesn't inherently support the embedding of PDF files. This means that if you try to directly include a PDF within your notebook, it will only show as a static link, requiring users to download and open the file separately.

The Solution: Utilizing IFrame for Dynamic Display

The solution lies in using the <iframe> HTML tag within your Jupyter notebook. This tag allows you to embed external content, including PDFs, directly into your notebook, creating a dynamic and interactive experience.

Here's a step-by-step guide:

1. Place your PDF file in the same directory as your Jupyter notebook. This ensures that the relative path to your PDF is correct.

2. Import the IPython.display module:

   from IPython.display import IFrame
   

3. Use the IFrame function to embed the PDF:

   IFrame(src="your_pdf_file.pdf", width="100%", height=600)
   

   • Replace "your_pdf_file.pdf" with the actual filename of your PDF.
   • Adjust the width and height parameters to control the size of the embedded PDF.

4. Run your Jupyter notebook cell containing the IFrame code.

   This will display the PDF directly within your notebook, allowing users to view and interact with it without leaving the GitHub page.

Example:

from IPython.display import IFrame

# Embed a PDF file named 'my_report.pdf'
IFrame(src="my_report.pdf", width="100%", height=600)

Additional Considerations:

• Security: Be aware that embedding external content with <iframe> can pose security risks. Ensure that the PDF you're embedding originates from a trusted source.
• Accessibility: For accessibility, consider providing alternative text descriptions for the embedded PDF.
• File Size: Larger PDF files might affect the loading time of your notebook. Consider optimizing file sizes for faster loading.

Using this technique, you can seamlessly integrate PDFs into your Jupyter notebooks on GitHub, creating a more engaging and comprehensive experience for your audience.