PDF Reader in JavaScript
JavaScript CSS HTML
timvandermeij Merge pull request #9975 from Snuffleupagus/getDestination-refactor
Re-factor `destinations`/`getDestination` to reduce unnecessary duplication, and reject non-string inputs
Latest commit 1268aea Aug 12, 2018
Permalink
Failed to load latest commit information.
.github Attempt to clarify the meaning of "extension" in the ISSUE_TEMPLATE Oct 21, 2017
docs Modified Examples to work without systemjs Jul 21, 2018
examples Modified Examples to work without systemjs Jul 21, 2018
extensions Provide custom messages for the `no-restricted-globals` ESLint rule, … Jul 23, 2018
external Provide custom messages for the `no-restricted-globals` ESLint rule, … Jul 23, 2018
l10n Update translations Aug 5, 2018
src Merge pull request #9975 from Snuffleupagus/getDestination-refactor Aug 12, 2018
test Merge pull request #9975 from Snuffleupagus/getDestination-refactor Aug 12, 2018
web Merge pull request #9920 from Snuffleupagus/getMetadata-linearization Jul 29, 2018
.editorconfig Uses editorconfig to maintain consistent coding styles Nov 14, 2015
.eslintignore Adds streams-lib polyfill and exports ReadableStream from shared/util. May 19, 2017
.eslintrc Provide custom messages for the `no-restricted-globals` ESLint rule, … Jul 23, 2018
.gitattributes Fixing C++,PHP and Pascal presence in the repo Oct 29, 2015
.gitignore Include `package-lock.json` for reproducible builds Jun 2, 2018
.gitmodules Update fonttools location and version (issue 6223) Jul 17, 2015
.mailmap Add mgol's name to AUTHORS, add .mailmap Nov 22, 2017
.travis.yml Travis CI: use most recent version of NPM Oct 27, 2016
AUTHORS Add SehyunPark to AUTHORS Nov 29, 2017
EXPORT Adds ECCN response statement Oct 23, 2017
LICENSE cleaned whitespace Feb 17, 2015
README.md README.md: suggest usage of https instead of git protocol Jul 27, 2018
gulpfile.js Fail when MD5 of test files fails on bots. Aug 4, 2018
package-lock.json Update packages Aug 5, 2018
package.json Update packages Aug 5, 2018
pdfjs.config Version 2.0 Oct 30, 2017
systemjs.config.js Provide custom messages for the `no-restricted-globals` ESLint rule, … Jul 23, 2018

README.md

PDF.js

PDF.js is a Portable Document Format (PDF) viewer that is built with HTML5.

PDF.js is community-driven and supported by Mozilla Labs. Our goal is to create a general-purpose, web standards-based platform for parsing and rendering PDFs.

Contributing

PDF.js is an open source project and always looking for more contributors. To get involved, visit:

Feel free to stop by #pdfjs on irc.mozilla.org for questions or guidance.

Getting Started

Online demo

Browser Extensions

Firefox

PDF.js is built into version 19+ of Firefox.

Chrome

  • The official extension for Chrome can be installed from the Chrome Web Store. This extension is maintained by @Rob--W.
  • Build Your Own - Get the code as explained below and issue gulp chromium. Then open Chrome, go to Tools > Extension and load the (unpackaged) extension from the directory build/chromium.

Getting the Code

To get a local copy of the current code, clone it using git:

$ git clone https://github.com/mozilla/pdf.js.git
$ cd pdf.js

Next, install Node.js via the official package or via nvm. You need to install the gulp package globally (see also gulp's getting started):

$ npm install -g gulp-cli

If everything worked out, install all dependencies for PDF.js:

$ npm install

Finally, you need to start a local web server as some browsers do not allow opening PDF files using a file:// URL. Run:

$ gulp server

and then you can open:

Please keep in mind that this requires an ES6 compatible browser; refer to Building PDF.js for usage with older browsers.

It is also possible to view all test PDF files on the right side by opening:

Building PDF.js

In order to bundle all src/ files into two production scripts and build the generic viewer, run:

$ gulp generic

This will generate pdf.js and pdf.worker.js in the build/generic/build/ directory. Both scripts are needed but only pdf.js needs to be included since pdf.worker.js will be loaded by pdf.js. The PDF.js files are large and should be minified for production.

Using PDF.js in a web application

To use PDF.js in a web application you can choose to use a pre-built version of the library or to build it from source. We supply pre-built versions for usage with NPM and Bower under the pdfjs-dist name. For more information and examples please refer to the wiki page on this subject.

Including via a CDN

PDF.js is hosted on several free CDNs:

Learning

You can play with the PDF.js API directly from your browser using the live demos below:

More examples can be found in the examples folder. Some of them are using the pdfjs-dist package, which can be built and installed in this repo directory via gulp dist-install command.

For an introduction to the PDF.js code, check out the presentation by our contributor Julian Viereck:

More learning resources can be found at:

Questions

Check out our FAQs and get answers to common questions:

Talk to us on IRC (Internet Relay Chat):

  • #pdfjs on irc.mozilla.org

File an issue:

Follow us on twitter: @pdfjs