The Pdf-js Plugin is for Grav CMS. It allows you to embed PDF files into pages via shortcode.
For a demo, visit my blog.
Installing the Pdf-js plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
GPM Installation (Preferred)
The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's terminal (also called the command line). From the root of your Grav install type:
bin/gpm install pdf-js
This will install the Pdf-js plugin into your
/user/plugins directory within Grav. Its files can be found under
To install this plugin, just download the zip version of this repository and unzip it under
/your/site/grav/user/plugins. Then, rename the folder to
pdf-js. You can find these files on GitHub or via GetGrav.org.
You should now have all the plugin files under
If you use the admin plugin, you can install directly through the admin plugin by browsing the
Plugins tab and clicking on the
Before configuring this plugin, you should copy the
user/config/plugins/pdf-js.yaml and only edit that copy.
Here is the default configuration and an explanation of available options:
||Set to false to disable this plugin completely.|
||Sets the Window width in pixels|
||Sets the Window height in pixels|
||The technique for embedding pdf files on the page|
||Show Used Technique (debug)|
Note that if you use the admin plugin, a file with your configuration, and named pdf-js.yaml will be saved in the
user/config/plugins/ folder once the configuration is saved in the admin.
This plugin uses the Shortcode Core infrastructure. Read those docs for the nitty gritty of how shortcodes work.
The Pdf-js shortcode is a self-closing
[pdfjs option1="value1" option2="value2" ... /], and it accepts the following options:
fileis the only required parameter. It points to the datafile you wish to load. By default, the plugin looks in the same folder as the page file. This is adequate for most usage. You can also load files from the
user/datafolder by prefixing your file name with
widthset the width of the window. If not evaluated, the default value is used.
heightset the height of the window. If not evaluated, the default value is used.
If all you're passing is the file name, then you can shorten the code to the form
FYI, slash is not essential.
Multiple PDF files can also be embedded on a page except for Pdf-Js.
[pdfjs file=filename.pdf](basic embed of pdf file in the same folder as the page itself)
[pdfjs file=filename.pdf width=300 height=400](basic embed of pdf file in the same folder as the page itself, in a window of 400 pixels in width and 300 pixels in height)
[pdfjs file=data:filename.pdf](basic embed of pdf file in the
[pdfjs file=data:subdir/filename.pdf](basic embed of pdf file in the
datacan take any name, for example:
repositoryor whatever you like.
Note: if the file name contains spaces use double quotes, for example: [pdfjs="first filename.pdf"] or [pdfjs file="first filename.pdf"] or [pdfjs="data:filename.pdf"] and so on.
Pdf-js is a general-purpose, web standards-based platform for parsing and rendering PDFs of Mozilla. More informations are available here: https://mozilla.github.io/pdf.js/.
Incorporate more than one pdf with Pdf-Js
Reduce the size of the Pdf-Js library.
Make the toolbar buttons available via Admin.
Solve this warning if possible:
Warning: Setting up fake worker.