Go to file
Jonas Jenwald 13d7244529 Re-factor how the pdf.sandbox.js file is built (PR 12604 follow-up)
The way that the `pdf.sandbox.js` building was implemented feels all kinds of inconsistent/wrong, and it "sticks out" quite a bit when compared to the rest of the `gulpfile.js`. This patch thus attempts to improve the current situation slightly, to hopefully make future maintenance easier.

One thing that strikes you, pretty immediately, when looking at PR 12604 is that the two new `gulp`-tasks added (i.e. `sandbox` and `watch-sandbox`) don't even work!?
The reason for this is that they implicitly dependent upon the result of the `buildnumber`-task, which isn't listed as a dependency. (Try running `gulp clean` *first*, and invoking any of the new `gulp`-tasks will inevitably fail.)

Furthermore, there's another (potentially big) problem with the implementation of e.g. the `gulp sandbox` task, since it doesn't actually wait for all building to complete before the task is considered as "done". This has the potential to cause all sorts of subtle bugs elsewhere, and the fact that things even "work" as-is can probably be attributed mostly to luck.

Unfortunately there's no *perfect* way to improve things here, since the `pdf.sandbox.js` file depends on including the `pdf.scripting.js` file as a string, however I firmly believe that improvements are still possible here.
To that end, this patch updates all relevant build-targets to create a *temporary* `pdf.scripting.js` file as part of the setup in the `gulp`-tasks, and then reads that file during the `pdf.sandbox.js` building.
This at least allows us to bring all of this "sandbox"-build code much more in-line with the existing build-system.
2020-12-05 23:04:32 +01:00
.github Update links from IRC to Matrix. 2020-02-27 16:26:17 -08:00
docs Bump versions in pdfjs.config and update the getting started page of the website for the new release 2020-06-01 12:45:04 +02:00
examples Enable the ESLint no-debugger and no-alert rules 2020-10-05 13:41:06 +02:00
extensions Add a new preference, viewerCssTheme, to allow forcing the use of the light/dark viewer CSS themes (issue 12290) 2020-11-16 21:13:13 +01:00
external Run gulp lint --fix, to account for changes in Prettier version 2.2.1 2020-11-29 10:01:46 +01:00
l10n Update l10n files 2020-11-29 09:50:36 +01:00
src Actually utilize the PDF.js build-system fully when bundling the pdf.sandbox.js file 2020-12-05 11:15:11 +01:00
test Update the link for the "pr8808" test-case (issue 12680) 2020-12-02 15:06:09 +01:00
web Merge pull request #12682 from Snuffleupagus/findbar-notFound 2020-12-02 22:00:41 +01:00
.editorconfig Uses editorconfig to maintain consistent coding styles 2015-11-14 07:32:18 +05:30
.eslintignore JS -- Add a sandbox based on quickjs 2020-11-19 13:40:46 +01:00
.eslintrc Some hasJSActions, and general annotation-code, related cleanup in the viewer and API 2020-11-14 13:58:35 +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
.gitpod.Dockerfile Simplifies code contributions by automating the dev setup with gitpod.io 2019-11-06 04:12:19 +00:00
.gitpod.yml Simplifies code contributions by automating the dev setup with gitpod.io 2019-11-06 04:12:19 +00:00
.mailmap Add mgol's name to AUTHORS, add .mailmap 2017-11-22 10:46:11 +01:00
.prettierrc Update Prettier to version 2.0 2020-04-14 12:28:14 +02:00
.stylelintignore Add (basic) support for Stylelint, to allow linting of CSS files 2020-08-30 21:48:35 +02:00
.stylelintrc Add (basic) support for Stylelint, to allow linting of CSS files 2020-08-30 21:48:35 +02:00
.travis.yml Use Node LTS releases to fix Travis CI builds (issue 10790) 2020-04-22 00:06:27 +02:00
AUTHORS Add SehyunPark to AUTHORS 2017-11-29 22:24:08 +09:00
CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file 2019-03-27 21:00:01 -07:00
EXPORT Adds ECCN response statement 2017-10-23 13:31:36 -05:00
gulpfile.js Re-factor how the pdf.sandbox.js file is built (PR 12604 follow-up) 2020-12-05 23:04:32 +01:00
lgtm.yml Try adding a very basic lgtm.yml file, to prevent LGTM complaining about unused variables (issue 11965) 2020-11-01 17:00:40 +01:00
LICENSE cleaned whitespace 2015-02-17 11:07:37 -05:00
package-lock.json Change how we're passing pdf.sandbox.js-specific options to createWebpackConfig in gulpfile.js 2020-12-05 22:44:48 +01:00
package.json Change how we're passing pdf.sandbox.js-specific options to createWebpackConfig in gulpfile.js 2020-12-05 22:44:48 +01:00
pdfjs.config Bump versions in pdfjs.config 2020-09-03 23:43:50 +02:00
README.md [api-minor] Only support browsers/environments that have *basic* support for Promise natively 2020-09-06 13:45:56 +02:00
systemjs.config.js docs: Fix simple typo, occurences -> occurrences 2020-04-18 07:53:18 +10:00

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. 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 our Matrix room for questions or guidance.

Getting Started

Online demo

Please note that the "Modern browsers" version assumes native support for features such as e.g. async/await, and ReadableStream.

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:

The API documentation can be found at:

Questions

Check out our FAQs and get answers to common questions:

Talk to us on Matrix:

File an issue:

Follow us on twitter: @pdfjs