Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #12874 from Snuffleupagus/docs-less-es5

Browse Source 
Put less emphasis on "ES5"/"ES6" in the README and other documentation
This commit is contained in:
Tim van der Meij 2021-01-19 18:52:16 +01:00 committed by GitHub
commit 2731dd4b49
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -24,7 +24,8 @@ Feel free to stop by our [Matrix room](https://chat.mozilla.org/#/room/#pdfjs:mo
### Online demo ### Online demo
Please note that the "Modern browsers" version assumes native support for Please note that the "Modern browsers" version assumes native support for
features such as e.g. `async`/`await`, and `ReadableStream`. features such as e.g. `async`/`await`, `ReadableStream`, optional chaining, and
nullish coalescing.
+ Modern browsers: https://mozilla.github.io/pdf.js/web/viewer.html + Modern browsers: https://mozilla.github.io/pdf.js/web/viewer.html
@ -70,7 +71,7 @@ and then you can open:
+ http://localhost:8888/web/viewer.html + http://localhost:8888/web/viewer.html
Please keep in mind that this requires an ES6 compatible browser; refer to [Building PDF.js](https://github.com/mozilla/pdf.js/blob/master/README.md#building-pdfjs) for usage with older browsers. Please keep in mind that this requires a modern and fully up-to-date browser; refer to [Building PDF.js](https://github.com/mozilla/pdf.js/blob/master/README.md#building-pdfjs) 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: It is also possible to view all test PDF files on the right side by opening:
@ -83,7 +84,11 @@ viewer, run:
$ gulp generic $ gulp generic
This will generate `pdf.js` and `pdf.worker.js` in the `build/generic/build/` directory. If you need to support older browsers, run:
$ gulp generic-es5
This will generate `pdf.js` and `pdf.worker.js` in the `build/generic/build/` directory (respectively `build/generic-es5/build/`).
Both scripts are needed but only `pdf.js` needs to be included since `pdf.worker.js` will 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. be loaded by `pdf.js`. The PDF.js files are large and should be minified for production.

2
docs/contents/getting_started/index.md
View File

@ -49,7 +49,7 @@ Before downloading PDF.js please take a moment to understand the different layer
</span> </span>
</div> </div>
<div class="col-md-4"> <div class="col-md-4">
<h3>Prebuilt (ES5-compatible)</h3> <h3>Prebuilt (for older browsers)</h3>
<p> <p>
Includes the generic build of PDF.js and the viewer. Includes the generic build of PDF.js and the viewer.
</p> </p>

5
external/dist/README.md vendored
View File

@ -7,7 +7,8 @@ parsing and rendering PDFs.
This is a pre-built version of the PDF.js source code. It is automatically This is a pre-built version of the PDF.js source code. It is automatically
generated by the build scripts. generated by the build scripts.
For usage with older browsers/environments, without support for modern features For usage with older browsers or environments, without support for modern
such as e.g. `async`/`await`, and `ReadableStream`, please see the `es5` folder. features such as e.g. `async`/`await`, `ReadableStream`, optional chaining, and
nullish coalescing; please see the `es5` folder.
See https://github.com/mozilla/pdf.js for learning and contributing. See https://github.com/mozilla/pdf.js for learning and contributing.