pdfmake README

The project's README from github.com/bpampuch/pdfmake. As one markdown file: README.md.

pdfmake Node.js CI GitHub npm

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

Check out the playground and examples.

Features

Documentation

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

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

Building from sources

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

MIT

Authors

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

Thanks to all contributors.

pdfmake (bpampuch/pdfmake)

Searching Database…

12.3K ·GitHub
Что это?pdfmake — библиотека для генерации PDF-документов, написанная на чистом JavaScript, которая работает и на сервере (Node.js), и на стороне клиента (в браузере).
Это фреймворк или библиотека?Это библиотека, которую вы подключаете к своему проекту на Node.js или в браузере, чтобы создавать PDF программно. Это не отдельное приложение.
Как добавить её в проект?Установите через npm или yarn, а затем соберите из исходников с помощью готовых скриптов. Также есть песочница (playground), где можно попробовать её без установки.
Использует ли она внутри другие библиотеки?Для низкоуровневой отрисовки PDF она опирается на pdfkit, а внутри также использует linebreak и xmldoc. Для сборки требуется Node.js 20 или новее.
Где она работает?Она работает на серверах Node.js и прямо в веб-браузерах, так как написана на чистом JavaScript.
Какие возможности вёрстки поддерживаются из коробки?Поддерживаются перенос строк, выравнивание текста, нумерованные и маркированные списки, таблицы с объединением ячеек по столбцам и строкам и с шириной auto, fixed или star, многоколоночная верстка в стиле газетных полос, изображения, векторная графика, колонтитулы, номера страниц, поля, произвольные разрывы страниц, встроенные шрифты и оглавление.
Можно ли задать метаданные PDF, например автора или тему?Да, pdfmake предоставляет вспомогательные методы для задания метаданных документа, например автора и тему, а также методы для открытия, печати или скачивания созданного PDF.
Creator
bpampuch
Size
149.4 MB
Stars
12.3K
Age
12y
Commits · 90 Days