Skip to content

ArtifexSoftware/mupdf.js

Repository files navigation

MuPDF.js

Welcome to the official MuPDF.js repository from Artifex.

This repository contains documentation and examples for how to use MuPDF in JavaScript and TypeScript environments.

Features

You can use MuPDF.js to build a PDF viewer, or a PDF editor, or to batch convert PDF files to other formats, or extract text contents. If you can imagine it, you can build it!

  • Open, manipulate, and save PDF files
  • Render documents to raster images
  • Extract structured text
  • Create and edit annotations
  • Fill out forms
  • Redact sensitive content

License and Copyright

MuPDF.js is available under Open Source AGPL and commercial license agreements. If you determine you cannot meet the requirements of the AGPL, please contact Artifex for more information regarding a commercial license.

Installing the Library

See INSTALL.md for how to get started using the library.

Using the Library

Check out the example projects to help you get started.

The examples include a simple PDF Viewer that runs MuPDF in the browser, several command line scripts, and more!

Contributing

To contribute please open up (or help answer!) an Issue on our Github project, or create a Pull Request for review.

Find us on Discord at #mupdf-js to chat with us directly.