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

sitetopdf

v1.1.0

Published

A command line program to convert a website to PDF or image using Puppeteer

Downloads

17

Readme

sitetopdf

sitetopdf is a versatile command-line utility that allows you to convert a webpage into a PDF or an image. It offers various customization options for the output, including page format, margins, and headers and footers for PDFs, as well as format-specific viewport sizing for images.

Installation

Install sitetopdf using npm:

npm install -g sitetopdf

Usage

To convert a website to PDF:

sitetopdf -u https://example.com -o output.pdf

To convert a website to an image:

sitetopdf -u https://example.com -i -p output.png

Options

| Option | Alias | Description | Default | | ----------------------- | ----- | ----------------------------------------------------------------------------- | ------------ | | --url | -u | URL of the website to convert | | | --output | -o | Output PDF file path | 'output.pdf' | | --image | -i | Generate an image instead of a PDF | | | --image-output | -p | Output image file path (required for image) | 'output.png' | | --format | -f | Paper format ('A4', 'Letter', etc.) | 'A4' | | --landscape | -l | Whether to set the PDF in landscape mode | false | | --scale | -s | Scale of the webpage rendering | '1' | | --margin-top | -m | Top margin of the PDF file | '0' | | --margin-bottom | -b | Bottom margin of the PDF file | '0' | | --margin-right | -r | Right margin of the PDF file | '0' | | --margin-left | -e | Left margin of the PDF file | '0' | | --header-template | -h | HTML template for the header of the PDF file | | | --footer-template | -t | HTML template for the footer of the PDF file | | | --display-header-footer | -n | Whether to display the header and footer of the PDF file | false | | --prefer-css-page-size | -c | Whether to prefer the CSS page size over the viewport size | false | | --page-ranges | -d | Page ranges to print, e.g., '1-5, 8, 11-13' | | | --ignore-http-errors | -a | Whether to ignore any HTTP errors that occur during the navigation | false | | --wait-until | -g | When to consider the navigation succeeded, e.g., 'networkidle0', 'load', etc. | 'load' | | --timeout | -k | Maximum navigation time in milliseconds | '30000' | | --verbose | -v | Display detailed information during execution | | | --content | -x | HTML content to set on the page | | | --content-type | | Type of content ('string' or 'file') | 'string' |

Examples

Convert a website to a PDF in landscape mode:

sitetopdf -u https://example.com -o output.pdf -l

Convert a website to a PDF with custom margins:

sitetopdf -u https://example.com -o output.pdf -m 1cm -b 1cm -r 1cm -e 1cm

Convert a website to a PDF with a custom header and footer:

sitetopdf -u https://example.com -o output.pdf -h "<div>Header</div>" -t "<div>Footer</div>" -n

Convert a website to an image with A4 viewport size:

sitetopdf -u https://example.com -i -p output.png -f A4

Set HTML content from a string and convert to an image:

sitetopdf -x '<html><body>Hello, world!</body></html>' -i -p output.png

Set HTML content from a string and convert to a PDF:

sitetopdf -x '<html><body>Hello, world!</body></html>' -o output.pdf

Set HTML content from a file and convert to a PDF:

sitetopdf -x "./path/to/file.html" --content-type file -o output.pdf

Show your support

Give a ⭐️ if this project helped you!