pdfme

pdfme

Website | Playground | Discord

⭐ pdfme is open source. If it saves you time, please star us on GitHub to help more developers discover it.

TypeScript-based PDF generator and React-based UI. Open source, developed by the community, and completely free to use under the MIT license!

Features

Fast PDF Generator	Easy PDF Template Design	Simple JSON Template
Works on Node and in the browser. Use templates to generate PDFs—complex operations are not required.	Anyone can easily create templates using the designer.	Templates are JSON data that is easy to understand and work with.

Custom Feature Requests

While pdfme is an open-source project released under the MIT License, we are open to considering custom feature additions for a fee.
If you are willing to pay, we can evaluate and implement your requested features.
Please note that any additional functionality will always be released as open source. If this approach works for you, please contact us.

For a detailed list of supported features, please refer to the Supported Features page.

Documentation

For complete documentation on pdfme, please refer to the Getting Started guide.

For the planned next major release changes, see the migration guide draft.

Need interactive help? Use DeepWiki to ask questions about pdfme’s documentation and source code directly.

CLI Workflow

For agentic workflows, local verification, or JSON-first template iteration, use @pdfme/cli.

• pdfme validate: validate template or unified job JSON before generation
• pdfme doctor: diagnose runtime, font, basePdf, and output-path issues before generate
• pdfme generate --image --grid: generate PDFs and inspect layout via rendered page images

Examples Using pdfme

If you’re looking for code examples to get started with pdfme, check out the pdfme-playground website and the playground source code. Setup instructions can be found in the DEVELOPMENT.md file.

Sponsors

Support this project by becoming a sponsor. Your logo will appear here with a link to your website.

ProgressLab	PhotoQuest	Famly	New Sponsor

Contributors

Special Thanks

• pdf-lib: Used for PDF generation.
• fontkit: Used for font rendering.
• PDF.js: Used for PDF viewing.
• React: Used in building the UI.
• form-render: Used in building the UI.
• antd: Used in building the UI.
• react-moveable, react-selecto, @scena/react-guides: Used in the Designer UI.
• dnd-kit: Used in the Designer UI.
• Lucide: Used in the Designer UI and Schema’s icon.

I definitely could not have created pdfme without these libraries. I am grateful to the developers of these projects.

If you want to contribute to pdfme, please refer to the Development Guide.
We look forward to your contributions!