pdfmake Documentation

Technical Documentation: bpampuch/pdfmake

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

pdfmake [![Node.js CI][githubactions_img]][githubactions_url] [![GitHub][github_img]][github_url] [![npm][npm_img]][npm_url]

PDF document generation library for server-side and client-side in pure JavaScript.

Check out the playground and examples.

Features Copy Section

• line-wrapping,
• text-alignments (left, right, centered, justified),
• numbered and bulleted lists,
• tables and columns
  • auto/fixed/star-sized widths,
  • col-spans and row-spans,
  • headers automatically repeated in case of a page-break,
  • snaking columns (newspaper-style layout where content flows column-to-column),
• images and vector graphics,
• convenient styling and style inheritance,
• page headers and footers:
  • static or dynamic content,
  • access to current page number and page count,
• background-layer,
• page dimensions and orientations,
• margins,
• document sections,
• custom page breaks,
• font embedding,
• support for complex, multi-level (nested) structures,
• table of contents,
• helper methods for opening/printing/downloading the generated PDF,
• setting of PDF metadata (e.g. author, subject).

Documentation Copy Chapter

Documentation URL: https://pdfmake.github.io/docs/

Source of documentation: https://github.com/pdfmake/docs Improvements are welcome!

Building from sources Copy Chapter

using npm:

git clone https://github.com/bpampuch/pdfmake.git
cd pdfmake
npm install
npm run build

using yarn:

git clone https://github.com/bpampuch/pdfmake.git
cd pdfmake
yarn
yarn run build

License Copy Chapter

MIT

Authors Copy Chapter

• @bpampuch (founder)
• @liborm85

pdfmake is based on a truly amazing library pdfkit (credits to @devongovett).

Thanks to all contributors.

Overview (`dev-playground/README.md`) Copy Section

Dev Playground Copy Chapter

Start from pdfmake ROOT directory with nodemon if you want server to restart with every change you make in pdfmake/src:

cd dev-playground
npm install # or: yarn
npm install nodemon
cd ..
nodemon ./dev-playground/server.js

--- METRICS ---

• Files Extracted: 2
• Estimated Token Budget: ~675 tokens
• Canonical Reference: https://codewiki.google/github.com/bpampuch/pdfmake