mirrors/pdf.js
1
0
Fork 0
mirror of https://github.com/mozilla/pdf.js.git synced 2025-04-19 06:38:07 +02:00
Code Activity
PDF Reader in JavaScript
19150 commits 1 branch 93 tags 292 MiB
Find a file
Tim van der Meij 4033913acc
Improve the security policy 
This commit fixes two issues that have been found after commit 2beae7a
landed, namely:

- The security checkbox image is not rendering at
  https://github.com/mozilla/pdf.js/security/policy because the
  `SECURITY.md` file is apparently served differently there (because it
  does work as expected at
  https://github.com/mozilla/pdf.js/blob/master/.github/SECURITY.md),
  which causes the relative link not to work. We switch to an absolute
  link to fix the issue.
- If a security policy is defined it turns out that GitHub automatically
  adds a row to the "New issue" page; see
  https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository
  where it states "When someone creates an issue in your repository, they
  will see a link to your project's security policy". Since we now have
  two rows at https://github.com/mozilla/pdf.js/issues/new/choose about
  the security policy, we remove our own version in favor of the
  standard GitHub-provided one.
2024-06-24 15:54:06 +02:00
.github Improve the security policy 2024-06-24 15:54:06 +02:00
docs Include the generated API documentation directly on the API page 2024-06-15 15:13:01 +02:00
examples Ensure that GenericL10n works if the locale files cannot be loaded 2024-01-31 14:07:11 +01:00
extensions Only disable HWA in m-c build and for local dev 2024-06-16 12:14:33 +02:00
external Update jpx decoder 2024-06-16 19:05:26 +02:00
l10n Update translations to the most recent versions 2024-06-21 17:11:30 +02:00
src Merge pull request #18306 from calixteman/bug1903731 2024-06-20 16:52:29 +02:00
test Don't ignore errors in the Jasmine suite start/end stages 2024-06-23 20:59:48 +02:00
web Try to shutdown Fluent "more" when closing the viewer during testing 2024-06-22 16:40:12 +02:00
.editorconfig Add the .mjs file-extension to the EditorConfig 2023-08-23 11:22:25 +02:00
.eslintignore Rename builder esprima fixtures to babel 2024-05-09 15:17:30 +02:00
.eslintrc Enable the no-new-symbol and require-yield ESLint rules 2024-02-11 13:27:22 +01:00
.git-blame-ignore-revs Ignore auto-formatting patches in git blame 2024-01-20 12:01:23 +01:00
.gitattributes [api-minor] Move to Fluent for the localization (bug 1858715) 2023-10-19 11:20:41 +02:00
.gitignore Include package-lock.json for reproducible builds 2018-06-02 20:29:47 +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
.prettierignore Rename builder esprima fixtures to babel 2024-05-09 15:17:30 +02:00
.prettierrc Update npm packages 2024-01-20 09:52:57 +01:00
.stylelintignore Rename builder esprima fixtures to babel 2024-05-09 15:17:30 +02:00
.stylelintrc Enable some Stylelint color-related rules to slightly reduce file sizes 2023-10-05 17:51:21 +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.mjs Update the regular expression in tweakWebpackOutput to support minified-legacy builds (issue 18290) 2024-06-19 12:21:10 +02:00
jsdoc.json Implement reproducibility for the JSDoc builds 2024-06-16 15:10:34 +02:00
LICENSE cleaned whitespace 2015-02-17 11:07:37 -05:00
package-lock.json Update dependencies to the most recent versions 2024-06-21 17:09:21 +02:00
package.json Update dependencies to the most recent versions 2024-06-21 17:09:21 +02:00
pdfjs.config Bump library version to 4.4 2024-05-30 18:56:13 +02:00
README.md Don't recommend installing gulp-cli globally in the README and on the website 2024-06-14 18:41:44 +02:00
tsconfig.json Target ES2022 when building the TypeScript definitions (issue 17932) 2024-05-24 12:14:58 +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. 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 the latest JavaScript features; please also see this wiki page.

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 npx 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. If everything worked out, install all dependencies for PDF.js:

$ npm install

Note

On MacOS M1/M2 you may see some node-gyp-related errors when running npm install. This is because one of our dependencies, "canvas", does not provide pre-built binaries for this platform and instead npm will try to build it from source. Please make sure to first install the necessary native dependencies using brew: https://github.com/Automattic/node-canvas#compiling.

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

$ npx gulp server

and then you can open:

Please keep in mind that this assumes the latest version of Mozilla Firefox; refer to Building PDF.js for non-development usage of the PDF.js library.

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:

$ npx gulp generic

If you need to support older browsers, run:

$ npx gulp generic-legacy

This will generate pdf.js and pdf.worker.js in the build/generic/build/ directory (respectively build/generic-legacy/build/). 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 npx 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: