[!WARNING] minpdf is under development. APIs may change.

The bindings use the same PDF engine and follow the same API. The library has no third-party runtime dependencies.

Installation

JavaScript and TypeScript

npm install minpdf

Node.js 18+, Bun, modern browsers, workers, and ESM bundlers are supported.

Python

python -m pip install minpdf-core

Go

go get github.com/actiledev/minpdf

The Go package uses cgo and requires CGO_ENABLED=1 and a C compiler.

C and C++

Copy include/minpdf.h into your project and define MINPDF_IMPLEMENTATION in one C translation unit, or compile core.c as a library.

cc -std=c11 -O2 app.c -o app

See the installation guide for more details.

Example

import { PDF, SIZES, rgb } from "minpdf";

const doc = await PDF.create(SIZES.A4);

try {
  doc
    .metadata({ title: "Hello minpdf", author: "minpdf" })
    .text("Hello, PDF!", 50, 55, { size: 24, weight: "bold" })
    .rect(50, 85, 240, 70, {
      fill: rgb(52, 152, 219),
      radius: 10,
    });

  await doc.save("hello.pdf");
} finally {
  doc.close();
}

Examples for other targets:

• C and C++
• Go
• Python
• JavaScript and TypeScript
• Browsers

Features

• PDF 1.4 output
• A3, A4, A5, Letter, and custom page sizes
• Text alignment and word wrapping
• Built-in Helvetica fonts and embedded TrueType fonts
• UTF-8 text with searchable Unicode maps
• Rectangles, circles, lines, and simple tables
• JPEG and non-interlaced 8-bit PNG images
• Links, metadata, and multiple pages
• File output, in-memory bytes, browser blobs, and downloads

minpdf creates new PDFs. It does not read, edit, merge, encrypt, sign, or render existing PDFs. See the roadmap for planned work.

Documentation

• Documentation index
• Core concepts
• Shared API
• Text and fonts
• Images
• Tables
• Output and errors
• Performance and development

Contributing

Read CONTRIBUTING.md before opening a pull request. This project uses the Contributor Covenant. Report vulnerabilities as described in SECURITY.md.

Licensed under the MIT License.