jeremybohannon / hugo-embed-pdf-shortcode

A shortcode for Hugo(https://gohugo.io/) which allows you to embed a PDF file in a page using Pdf.js (https://mozilla.github.io/pdf.js/)

hugo-embed-pdf-shortcode

---

Table of Contents

• Online Demo
• Introduction
• Setup
• Usage
• FAQ
• Support
• License

---

Introduction

[Back to Top]

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.

1. Clone this repository

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

2. 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

3. 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 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.
• hideLoader (optional): Boolean which expects true or false. Hides the loading spinner while your document loads.

Note: Currently supports local file embed. If absolute URL from the remote server is provided, configure the CORS header on that server.

FAQ

[Back to Top]

Support

[Back to Top] You an reach me at:

• Twitter : @anvith3

For any bugs, enhancement requests, feature requests please raise issues here

License

[Back to Top]

• MIT license