PDF Reader in JavaScript
JavaScript CSS HTML
Latest commit aaec490 Dec 7, 2016 @timvandermeij timvandermeij committed on GitHub Merge pull request #7881 from Snuffleupagus/fixMetadata-constant-cond…
…ition

Remove a misplaced `false` from a condition in `fixMetadata`, in `metadata.js`, since it currently short circuits the entire condition
Permalink
Failed to load latest commit information.
.github Add an ISSUE_TEMPLATE Mar 23, 2016
docs Github -> GitHub May 26, 2016
examples Widget annotation: implement field name according to the specification Nov 2, 2016
extensions Adds SVG rendering capabilities to the PDFViewer. Nov 18, 2016
external Refactor toolbar (and secondary toolbar). Nov 18, 2016
l10n Update l10n files Dec 5, 2016
src Remove a misplaced `false` from a condition in `fixMetadata`, in `met… Dec 7, 2016
test Adjust one of the Page Label unit-tests to use a PDF file where the "… Dec 4, 2016
web Don't fail if mozL10n is not present. Dec 1, 2016
.editorconfig Uses editorconfig to maintain consistent coding styles Nov 14, 2015
.gitattributes Fixing C++,PHP and Pascal presence in the repo Oct 29, 2015
.gitignore Added svg export tool Aug 14, 2014
.gitmodules Update fonttools location and version (issue 6223) Jul 17, 2015
.jshintignore Lint: do not ignore `external/importL10n` as it is one of our components Nov 1, 2016
.jshintrc Replaces all preprocessor directives with PDFJSDev calls. Oct 14, 2016
.travis.yml Travis CI: use most recent version of NPM Oct 27, 2016
AUTHORS Adding to authors Nov 7, 2015
LICENSE cleaned whitespace Feb 17, 2015
README.md Add HTTPS support Nov 4, 2016
gulpfile.js Enable removing of all comments (except for Copyright notices) when p… Nov 11, 2016
make.js Make: include minified library files for the distribution target Nov 23, 2016
package.json Gulp: port the `all`, `extension` and `jsdoc` targets Oct 16, 2016
pdfjs.config Release of 1.6.210 Oct 4, 2016

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 checkout:

For further questions or guidance feel free to stop by #pdfjs on irc.mozilla.org.

Getting Started

Online demo

Browser Extensions

Firefox (and Seamonkey)

PDF.js is built into version 19+ of Firefox, however one extension is still available:

  • Development Version - This extension is mainly intended for developers/testers, and it is updated every time new code is merged into the PDF.js codebase. It should be quite stable, but might break from time to time.

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 git://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

  • http://localhost:8888/web/viewer.html

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

  • http://localhost:8888/test/pdfs/?frame

Building PDF.js

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

$ 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. If you want to support more browsers than Firefox you'll also need to include compatibility.js from build/generic/web/. 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.

Learning

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

The repo contains a hello world example that you can run locally:

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

You can read more about PDF.js here:

Even more learning resources can be found at:

Questions

Check out our FAQs and get answers to common questions:

Talk to us on IRC:

  • #pdfjs on irc.mozilla.org

Join our mailing list:

Subscribe either using lists.mozilla.org or Google Groups:

Follow us on twitter: @pdfjs

Weekly Public Meetings