Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
11,424 Commits 1 Branch 80 Tags 254 MiB
JavaScript 79.4%
Fluent 18.3%
CSS 1.5%
HTML 0.8%
9fa7ae1397
Go to file
Tim van der Meij 9fa7ae1397
Merge pull request #10545 from timvandermeij/undo-bump 
Undo the `pdfjs.config` version bumps
2019-02-12 00:07:38 +01:00
.github Attempt to clarify the meaning of "extension" in the ISSUE_TEMPLATE 2017-10-21 11:32:03 +02:00
docs Switch to HTTPS for the license link on the website 2019-01-05 15:35:17 +01:00
examples Update the mobile-viewer example to use the new PDFHistory.initialize format (PR 10423 follow-up) 2019-01-23 15:27:19 +01:00
extensions Attempt to migrate the old showPreviousViewOnLoad/disablePageMode preferences to the new viewOnLoad preference 2019-02-02 10:21:18 +01:00
external Convert some usage of indexOf to startsWith/includes where applicable 2019-01-18 17:57:41 +01:00
l10n Update translations 2019-01-20 16:32:35 +01:00
src Fix copying on supplementary plane characters 2019-02-10 18:14:53 +09:00
test Fix copying on supplementary plane characters 2019-02-10 18:14:53 +09:00
web Convert more code to use classList.toggle with the force parameter 2019-02-06 17:18:45 +01:00
.editorconfig Uses editorconfig to maintain consistent coding styles 2015-11-14 07:32:18 +05:30
.eslintignore Turn on ESLint in examples directory, apply examples-specific exceptions 2018-12-11 15:23:26 +01:00
.eslintrc Enable the no-useless-catch ESLint rule 2019-01-28 11:00:09 +01:00
.gitattributes Fixing C++,PHP and Pascal presence in the repo 2015-10-29 13:03:51 -05:00
.gitignore Include package-lock.json for reproducible builds 2018-06-02 20:29:47 +02:00
.gitmodules Update fonttools location and version (issue 6223) 2015-07-17 12:51:09 +02:00
.mailmap Add mgol's name to AUTHORS, add .mailmap 2017-11-22 10:46:11 +01:00
.travis.yml Upgrade to Gulp 4 2018-12-17 16:20:13 +01:00
AUTHORS Add SehyunPark to AUTHORS 2017-11-29 22:24:08 +09:00
EXPORT Adds ECCN response statement 2017-10-23 13:31:36 -05:00
gulpfile.js Try to hack-around the broken pdfjs-dist links, such that they will point to the main library releases (issue 10391) 2019-02-09 17:25:20 +01:00
LICENSE cleaned whitespace 2015-02-17 11:07:37 -05:00
package-lock.json Update packages 2019-01-20 16:34:24 +01:00
package.json Update packages 2019-01-20 16:34:24 +01:00
pdfjs.config Undo the pdfjs.config version bumps 2019-02-12 00:05:51 +01:00
README.md Add Build Status Button 2018-10-13 18:26:48 -04:00
systemjs.config.js Provide custom messages for the no-restricted-globals ESLint rule, and refactor the .eslintrc files (PR 9868 follow-up) 2018-07-23 14:10:13 +02:00

README.md

PDF.js Build Status

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