npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

add-html-to-pdf

v1.0.5

Published

Add custom HTML to each page of a PDF document. Style the elements with inline CSS.

Downloads

6

Readme

add-html-to-pdf

Add custom HTML, CSS and images to an existing PDF document.

It uses a Docker image from pdf2htmlex to convert your PDF document to HTML format, inserts your HTML on each page using Cheerio and then converts back to PDF using wkhtmltopdf.

Installation:

npm install add-html-to-pdf --save

Required dependencies:

Docker: https://docs.docker.com/install/

wkhtmltopdf: https://wkhtmltopdf.org/downloads.html

Examples

Using inline HTML and CSS:

const pdf = require('add-html-to-pdf');

var options = {
  input: 'sample.pdf',
  output: 'done.pdf',
  html: "<div style='color:red'>This is awesome!</div>",
}

(async function() {
  await pdf.insertHTMLInPDF(options);
})()

Using a HTML file:

const pdf = require('add-html-to-pdf');

var options = {
  input: 'input.pdf',
  output: 'done.pdf',
  htmlFile: "index.html",
}

(async function() {
  await pdf.insertHTMLInPDF(options);
})()

Inserting on page 1 and 2 only:

const pdf = require('add-html-to-pdf');

var options = {
  input: 'input.pdf',
  output: 'done.pdf',
  htmlFile: "index.html",
  specificPages: [1,2]
}

(async function() {
  await pdf.insertHTMLInPDF(options);
})()

Options:

  input: Relative path of input. Must have .pdf extension if useDocker is set to true. Must have .html extension if useDocker is set to false.
  output: Relative path of output file. Defaults to './annotated.pdf'.
  html: HTML string to add to each page. Inline CSS can be used.
  htmlFile: Relative path of HTML file to add to each page (e.g. 'try.html').
  pages: Amount of pages in the PDF to add the HTML to. Defaults to 100.
  specificPages: Add HTML to specific pages only. Accepts an array of page numbers. Leave undefined to add HTML to all pages.
  useDocker: Whether to use Docker or not. If set to false, input has to be a html file. If set to true, input has to be a pdf file. Defaults to true.
  dockerOptions: Optional Docker Options, see https://www.npmjs.com/package/docker-cli-js

NB: Docker may require sudo priveleges on Linux.

An alternative that does not require Docker would be to install pdf2htmlEX (https://github.com/coolwanglu/pdf2htmlEX) and convert from PDF to HTML manually. Then supply the HTML document as input and set the useDocker flag to false.