comparison mupdf-source/platform/wasm/README.md @ 3:2c135c81b16c

MERGE: upstream PyMuPDF 1.26.4 with MuPDF 1.26.7
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:44:09 +0200
parents b50eed0cc0ef
children
comparison
equal deleted inserted replaced
0:6015a75abc2d 3:2c135c81b16c
1 # MuPDF.js
2
3 Welcome to the official MuPDF.js library from [Artifex](https://artifex.com).
4
5 Use [MuPDF](https://mupdf.com) in your JavaScript and TypeScript projects!
6
7 This library is powered by WebAssembly and can be used in all the usual
8 JavaScript environments: Node, Bun, Firefox, Safari, Chrome, etc.
9
10 ## License
11
12 MuPDF.js is available under Open Source
13 [AGPL](https://www.gnu.org/licenses/agpl-3.0.html) and commercial license
14 agreements.
15
16 > If you cannot meet the requirements of the AGPL, please contact
17 > [Artifex](https://artifex.com/contact/mupdf-inquiry.php) regarding a
18 > commercial license.
19
20 ## Installation
21
22 npm install mupdf
23
24 ## Usage
25
26 The module is only available as an ESM module!
27
28 import mupdf from "mupdf"
29
30 var doc = mupdf.Document.openDocument("test.pdf")
31 console.log(doc.countPages())
32
33 Check out the [example projects](examples/) to help you get started.
34
35 ## Documentation
36
37 - [MuPDF.js Reference](https://mupdf.readthedocs.io/en/latest/reference/javascript/)
38 - [Getting Started & Examples](https://mupdfjs.readthedocs.io/en/latest/)
39
40 ## Contact
41
42 Join the Discord at [#mupdf.js](https://discord.gg/zpyAHM7XtF) to chat with the
43 developers directly.