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

augmented-reality-pdf

v1.0.2

Published

A module to prepare PDF documents for AR. It automatically inserts a QR code and an image target of choice on each page of the document.

Downloads

9

Readme

augmented-reality-pdf

Prepare your PDF for Augmented Reality by adding a marker and a QR code to each page.

Before:

Before

After:

After

Installation:

npm install augmented-reality-pdf --save

Required dependencies:

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

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

Example:

const pdf = require('augmented-reality-pdf');

var options = {
  input: 'sample.pdf',
  output: 'done.pdf',
  target: 'target.jpg',
  text: 'Hello there!',
  width: 100,
  height: 100,
  top: 1400,
  left: 0,
  useDocker: true
}

pdf.insertQRAndMarker(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: Desired relative path of output file. Defaults to 'annotated.pdf'
    target: Relative path of marker
    width: Width of image target/QR code in pixels
    height: Height of image target/QR code in pixel
    text: Text to automatically generate QR code from
    qr: Relative path of QR code image if not using automatically generated QR code from text
    top: Offset from top of page of image target/QR code in pixels
    left: Offset from left of page of image target/QR code in pixels
    pages: Number of pages in the PDF document to place target/QR code on
    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.
    dockerOptions: Optional Docker Options, see https://www.npmjs.com/package/docker-cli-js
    useImageTarget: Whether to embed a marker or not. Defaults to true.
    useQRCode: Whether to embed a QR code or not. Defaults to true.

NB: Docker may require sudo priveleges on Linux.