Please note that this guide is not updated to the version 0.2.0 (will be updated asap)
The most important change is the alternatives added to pdf-js. Now you can also use pdfobject or embed or object tags
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.
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:
enabled: true height: 300
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
, and it accepts the following options:
PDF-Js: Could not resolve file name '[pdfjs option1=value1 option2=value2 ...'.
file is 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/data folder by prefixing your file name with
If all you're passing is the file name, then you can shorten the code to the form
(basic embed of pdf file in the same folder as the page itself)
(basic embed of pdf file in the
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/
[ ] Reduce the size of the library.
[ ] Make the toolbar buttons available via Admin.
Warning: Setting up fake worker.