embedpdf Example

Simple Usage

All you really need to give the pdf shortcode is the path to the PDF file you want to embed in your Quarto HTML document.

{{< pdf dummy.pdf >}}

Customization

However, in most cases, you will want to customize the appearance of your embedded PDF object. I have built a few common HTML-based customizations into the pdf shortcode for your convenience. However, the most powerful and flexible approach to customization will be to use cascading style sheets or CSS (e.g., by passing the pdf shortcode a CSS class). If you are new to CSS, there are some good introductory resources available here and here.

Embed with width in pixels

{{< pdf dummy.pdf width=600 >}}

Embed with width in percent

{{< pdf dummy.pdf width=100% >}}

Embed with height in pixels

{{< pdf dummy.pdf height=600 >}}

Embed with both width and height

{{< pdf dummy.pdf width=600 height=400 >}}

Embed with 1 px border

{{< pdf dummy.pdf border=1 >}}

Embed with CSS class

{{< pdf dummy.pdf class=myclass >}}

Supporting Mobile Browsers

Unfortunately, very few mobile browsers support the rendering of PDF objects and those that do (e.g., Safari on iOS) can often render the object in strange ways (e.g,. stretching and distorting its appearance). I have built an image-based backup option that I recommend for now, and am experimenting with a javascript-based approach that I hope may one day provide full PDF support on mobile.

Add a backup image

The browser will render the PDF if able but, if not able (e.g., on mobile), it will fallback to rendering the provided image with a hyperlink to download the PDF file. I usually take a screenshot of the PDF file to create this image, but you could use any image you like (e.g., a download button image). For this reason, I provide separate customization arguments for the image.

{{< pdf dummy.pdf width=400 height=600 border=1 image=dummy.png image_width=400 image_border=1 >}}

To see what this will look like on a browser that does support PDF (e.g., during development), you can use image_force=TRUE:

{{< pdf dummy.pdf width=400 height=600 image=dummy.png image_force=TRUE border=1 image_width=400 image_border=1 >}}