hugo-embed-pdf-shortcode

Online Demo
Introduction
Setup
Usage
FAQ
Support
Who uses embed-pdf
License

Introduction

This is a Hugo Shortcode developed for use in Hugo based websites. This shortcode allows you to embed a PDF file in a page on your Hugo website. It is developed using the PDF.js library by Mozilla.

Setup

[Back to Top]

Note: This shortcode is for use in Hugo based websites. It will not work anywhere else.

Clone this repository

git clone https://github.com/anvithks/hugo-embed-pdf-shortcode.git
cd hugo-embed-pdf-shortcode

Copy the file ./layouts/shortcodes/embed-pdf.html to ./layouts/shortcodes in your Hugo website directory.

Note: If you do not have a ./layouts/shortcodes directory you can create it.

cp ./layouts/shortcodes/embed-pdf.html /path/to/your/hugo/website/layouts/shortcodes

Copy the file ./layouts/partials/embed-pdf-dependencies.html to ./layouts/partials in your Hugo website directory.

cp ./layouts/partials/embed-pdf-dependencies.html /path/to/your/hugo/website/layouts/partials

Add the embed-pdf-dependencies.html partial to your theme.

You'll want to add the following line to a layout in your partials directory responsible for generating the <head> section of your blog. This will include the JavaScript dependencies and CSS styles for the hugo-embed-pdf shortcode exactly once on pages that use it.

{{ partial "embed-pdf-dependencies.html" . }}

Copy the pdf.js library files from ./static/js/pdf-js to ./static/js in your Hugo website directory.

Note: If you do not have a ./static/js directory you can create it.

cp -R ./static/js/pdf-js /path/to/your/hugo/website/static/js/

Usage

[Back to Top]

In your Hugo website place the following shortcode in any of the markdown pages.

{{< embed-pdf url="./path/to/pdf/file/example.pdf" >}}

To hide pagination

{{< embed-pdf url="./path/to/pdf/file/example.pdf" hidePaginator="true" >}}

To render a selected page number

{{< embed-pdf url="./path/to/pdf/file/example.pdf" renderPageNum="5" >}}

To hide loading spinner

{{< embed-pdf url="./path/to/pdf/file/example.pdf" hideLoader="true" >}}

Parameters

url (required) : The relative location of the file.
hidePaginator (optional): Boolean which expects true or false. Hides the paginator for single page documents.
renderPageNum (optional): Integer which expects any number from 1 up to the last page number in the document. Will render that specific page on initial load.
hideLoader (optional): Boolean which expects true or false. Hides the loading spinner while your document loads.