New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

sitetopdf

Package Overview
Dependencies
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

sitetopdf

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

  • 1.1.0
  • latest
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

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

OptionAliasDescriptionDefault
--url-uURL of the website to convert
--output-oOutput PDF file path'output.pdf'
--image-iGenerate an image instead of a PDF
--image-output-pOutput image file path (required for image)'output.png'
--format-fPaper format ('A4', 'Letter', etc.)'A4'
--landscape-lWhether to set the PDF in landscape modefalse
--scale-sScale of the webpage rendering'1'
--margin-top-mTop margin of the PDF file'0'
--margin-bottom-bBottom margin of the PDF file'0'
--margin-right-rRight margin of the PDF file'0'
--margin-left-eLeft margin of the PDF file'0'
--header-template-hHTML template for the header of the PDF file
--footer-template-tHTML template for the footer of the PDF file
--display-header-footer-nWhether to display the header and footer of the PDF filefalse
--prefer-css-page-size-cWhether to prefer the CSS page size over the viewport sizefalse
--page-ranges-dPage ranges to print, e.g., '1-5, 8, 11-13'
--ignore-http-errors-aWhether to ignore any HTTP errors that occur during the navigationfalse
--wait-until-gWhen to consider the navigation succeeded, e.g., 'networkidle0', 'load', etc.'load'
--timeout-kMaximum navigation time in milliseconds'30000'
--verbose-vDisplay detailed information during execution
--content-xHTML content to set on the page
--content-typeType 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!

Keywords

FAQs

Package last updated on 22 Nov 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc