Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Put less emphasis on "ES5"/"ES6" in the README and other documentation #12874

Merged
merged 2 commits into from
Jan 19, 2021
Merged

Put less emphasis on "ES5"/"ES6" in the README and other documentation #12874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abd2346
Put less emphasis on "ES5"/"ES6" in the README and other documentation
Snuffleupagus Jan 19, 2021
5520737
Update the main, and pdfjs-dist, README to also include recent ECMASc…
Snuffleupagus Jan 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ Feel free to stop by our [Matrix room](https://chat.mozilla.org/#/room/#pdfjs:mo
### Online demo

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

Expand Down Expand Up @@ -70,7 +71,7 @@ and then you can open:

+ 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:

Expand All @@ -83,7 +84,11 @@ viewer, run:

$ 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
be loaded by `pdf.js`. The PDF.js files are large and should be minified for production.

Expand Down
2 changes: 1 addition & 1 deletion docs/contents/getting_started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Before downloading PDF.js please take a moment to understand the different layer
</span>
</div>
<div class="col-md-4">
<h3>Prebuilt (ES5-compatible)</h3>
<h3>Prebuilt (for older browsers)</h3>
<p>
Includes the generic build of PDF.js and the viewer.
</p>
Expand Down
5 changes: 3 additions & 2 deletions external/dist/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ parsing and rendering PDFs.
This is a pre-built version of the PDF.js source code. It is automatically
generated by the build scripts.

For usage with older browsers/environments, without support for modern features
such as e.g. `async`/`await`, and `ReadableStream`, please see the `es5` folder.
For usage with older browsers or environments, without support for modern
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.