Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
13,366 Commits 1 Branch 80 Tags 254 MiB
JavaScript 79.4%
Fluent 18.3%
CSS 1.5%
HTML 0.8%
81525fd446
Go to file
Jonas Jenwald 81525fd446 Use ESLint to ensure that exports are sorted alphabetically 
There's built-in ESLint rule, see `sort-imports`, to ensure that all `import`-statements are sorted alphabetically, since that often helps with readability.
Unfortunately there's no corresponding rule to sort `export`-statements alphabetically, however there's an ESLint plugin which does this; please see https://www.npmjs.com/package/eslint-plugin-sort-exports

The only downside here is that it's not automatically fixable, but the re-ordering is a one-time "cost" and the plugin will help maintain a *consistent* ordering of `export`-statements in the future.
*Note:* To reduce the possibility of introducing any errors here, the re-ordering was done by simply selecting the relevant lines and then using the built-in sort-functionality of my editor.
2021-01-09 20:37:51 +01:00
.github Switch from Travis CI to GitHub Actions 2020-12-19 22:01:58 +01: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 Merge pull request #12815 from Snuffleupagus/update-webpack-example 2021-01-07 22:24:24 +01: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 Try to fix TypeScript definitions for the es5-build in pdfjs-dist (issue 12872) 2021-01-08 09:29:47 +01:00
l10n Add support for finding/highlighting the outlineItem, corresponding to the currently visible page, in the sidebar (issue 7557, bug 1253820, bug 1499050) 2021-01-09 16:09:44 +01:00
src Use ESLint to ensure that exports are sorted alphabetically 2021-01-09 20:37:51 +01:00
test Use ESLint to ensure that exports are sorted alphabetically 2021-01-09 20:37:51 +01:00
web Use ESLint to ensure that exports are sorted alphabetically 2021-01-09 20:37:51 +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 Use ESLint to ensure that exports are sorted alphabetically 2021-01-09 20:37:51 +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
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 Try to re-add the worker-loader package, in pdfjs-dist, using peerDependencies (PR 11474 follow-up) 2021-01-06 11:02:13 +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 Use ESLint to ensure that exports are sorted alphabetically 2021-01-09 20:37:51 +01:00
package.json Use ESLint to ensure that exports are sorted alphabetically 2021-01-09 20:37:51 +01:00
pdfjs.config Bump versions in pdfjs.config 2020-09-03 23:43:50 +02:00
README.md Switch the badge in the README from Travis CI to GitHub Actions 2020-12-29 16:32:52 +01:00
systemjs.config.js docs: Fix simple typo, occurences -> occurrences 2020-04-18 07:53:18 +10: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 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