PDF.js

PDF.js 是一个使用HTML5构建的便携式文档格式（PDF）查看器。

PDF.js是一个社区驱动的项目，由Mozilla支持。我们的目标是创建一个基于Web标准的通用平台，用于解析和渲染PDF文件。

贡献

PDF.js是一个开源项目，一直在寻找更多贡献者。要参与，请访问：

• 问题报告指南
• 代码贡献指南
• 常见问题
• 适合新手的Bug
• 项目

如有疑问或需要指导，欢迎加入我们的Matrix聊天室。

入门

在线演示

请注意，"现代浏览器"版本假定原生支持最新的JavaScript功能；另请参阅此wiki页面。

• 现代浏览器：https://mozilla.github.io/pdf.js/web/viewer.html

• 旧版浏览器：https://mozilla.github.io/pdf.js/legacy/web/viewer.html

浏览器扩展

Firefox

PDF.js内置于Firefox 19+版本中。

Chrome

• Chrome的官方扩展可以从Chrome网上应用店安装。 此扩展由@Rob--W维护。
• 自行构建 - 按照下面的说明获取代码，然后执行npx gulp chromium。然后打开Chrome，进入工具 > 扩展程序，并从build/chromium目录加载（未打包的）扩展。

获取代码

要获取当前代码的本地副本，请使用git克隆：

$ git clone https://github.com/mozilla/pdf.js.git
$ cd pdf.js

接下来，通过官方软件包或nvm安装Node.js。如果一切顺利，安装PDF.js的所有依赖项：

$ npm install

[!注意] 在MacOS M1/M2上运行npm install时，您可能会看到一些与node-gyp相关的错误。这是因为我们的一个依赖项"canvas"不提供此平台的预构建二进制文件，而npm会尝试从源代码构建它。请确保首先使用brew安装必要的本地依赖项：https://github.com/Automattic/node-canvas#compiling。

最后，您需要启动本地Web服务器，因为某些浏览器不允许使用file:// URL打开PDF文件。运行：

$ npx gulp server

然后您可以打开：

• http://localhost:8888/web/viewer.html

请记住，这假定使用最新版本的Mozilla Firefox；有关PDF.js库的非开发用途，请参阅构建PDF.js。

还可以通过打开以下链接查看右侧的所有测试PDF文件：

• http://localhost:8888/test/pdfs/?frame

构建PDF.js

要将所有src/文件打包成两个生产脚本并构建通用查看器，请运行：

$ npx gulp generic

如果需要支持older browser，请运行：

$ npx gulp generic-legacy

这将在build/generic/build/目录（分别为build/generic-legacy/build/）中生成pdf.js和pdf.worker.js。 两个脚本都是必需的，但只需包含pdf.js，因为pdf.worker.js将由pdf.js加载。PDF.js文件较大，应该在生产环境中进行压缩。

在Web应用程序中使用PDF.js

要在Web应用程序中使用PDF.js，您可以选择使用预构建版本的库或从源代码构建。我们以pdfjs-dist的名称提供预构建版本，供NPM和Bower使用。有关更多信息和示例，请参阅wiki页面。

通过CDN包含

PDF.js托管在几个免费的CDN上：

• https://www.jsdelivr.com/package/npm/pdfjs-dist
• https://cdnjs.com/libraries/pdf.js
• https://unpkg.com/pdfjs-dist/

学习

您可以使用以下在线演示直接在浏览器中体验PDF.js API：

• 交互式示例

更多示例可以在examples文件夹中找到。其中一些使用pdfjs-dist包，可以通过在此存储库目录中运行npx gulp dist-install命令来构建和安装。

要了解PDF.js代码的介绍，请查看我们的贡献者Julian Viereck的演讲：

• https://www.youtube.com/watch?v=Iv15UY-4Fg8

更多学习资源可以在以下位置找到：

• https://github.com/mozilla/pdf.js/wiki/Additional-Learning-Resources

API文档可以在以下位置找到：

• https://mozilla.github.io/pdf.js/api/

问题

查看我们的常见问题解答，获取常见问题的答案：

• https://github.com/mozilla/pdf.js/wiki/Frequently-Asked-Questions

在Matrix上与我们交流：

• https://chat.mozilla.org/#/room/#pdfjs:mozilla.org

提交问题：

• https://github.com/mozilla/pdf.js/issues/new