Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
PDF Reader in JavaScript optimized for touch interfaces like kiosk systems
Pull request Compare This branch is even with adlerweb:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
extensions
external
l10n
src
test
web
.gitignore
.jshintrc
.travis.yml
AUTHORS
LICENSE
README.md
make.js
package.json

README.md

PDF.js

PDF.js is 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

PDF.js is built into version 19+ of Firefox, however two extensions are still available that are updated at a different rate:

  • Development Version - This version is updated every time new code is merged into the PDF.js codebase. This should be quite stable but still might break from time to time.
  • Stable Version - After version 24 of Firefox is released we no longer plan to support the stable extension. The stable version will then be considered whatever is built into Firefox.

Chrome

The Chrome extension is still somewhat experimental but it can be installed two ways:

  • Unofficial Version - This extension is maintained by a PDF.js contributor.
  • Build Your Own - Get the code as explained below and issue node make extension. Then open Chrome, go to Tools > Extension and load the (unpackaged) extension from the directory build/chrome.

Requirements

You need to have node 0.8.x installed.

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 pdfjs
$ cd pdfjs

Next, you need to start a local web server as some browsers don't allow opening PDF files for a file:// url:

$ node make server

You can install Node via nvm or the official package. If everything worked out, you can now serve

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

You can also view all the test pdf files on the right side serving

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

Building PDF.js

In order to bundle all src/ files into a final pdf.js and build the generic viewer, issue:

$ node make generic

This will generate the file build/generic/build/pdf.js that can be included in your final project. The pdf.js file is large and should be minified for production. Also, if you would like to support more browsers than Firefox you'll also need to include compatibility.js from build/generic/web/.

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

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

  • Bug Triage - Every Monday 1:00PM PDT*
  • Engineering - Every Thursday 10:00AM PDT*

*Meeting times can vary a bit, so check on IRC first if you plan to attend.

Connection Details

  • 650-903-0800 or 650-215-1282 x92 Conf# 99363 (US/INTL)
  • 1-800-707-2533 (pin 369) Conf# 99363 (US toll free)
  • irc.mozilla.org #pdfjs for backchannel

Meeting Notes

Follow the format of:

  • Triage - etherpad.mozilla.org/pdfjs-triage-YYYY-MM-DD
  • Engineering - etherpad.mozilla.org/pdfjs-YYYY-MM-DD
Something went wrong with that request. Please try again.