PDFKit 0.11.0 User Guide

About this manual

This document serves as the user guide for PDFKit version 0.11.0, a JavaScript library designed for generating PDF documents. It details how to install the package using npm and provides examples of creating PDFDocument instances in both Node.js environments and web browsers.

The guide covers fundamental operations such as adding pages with specific layouts and margins, switching between buffered pages to add content retroactively, setting default fonts like Helvetica or Courier, and configuring document metadata including title, author, and keywords.

What's inside

• Getting Started
• Installation
• Creating a Document
• Using PDFKit in the Browser
• Adding Pages
• Switching to Previous Pages
• Setting Default Font
• Setting Document Metadata
• Encryption and Access Privileges
• Paper Sizes

Specifications

Frequently asked questions

How do I install PDFKit?

Use the npm package manager by typing 'npm install pdfkit'.

Can PDFKit be used in the browser?

Yes, it can be used via module bundlers like Browserify or Webpack.

How do I add page numbers to a document?

Enable bufferPages mode and use doc.switchToPage() to navigate back and add text.