Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

puppeteer-render-text-cli

1.0.1 • Public • Published

puppeteer-render-text-cli

CLI for rendering text with headless chrome.

NPM Build Status JavaScript Style Guide

Logo

This CLI is also available as a library.

Why?

ImageMagick is the traditional unix tool to programatically render text, and while it works very well for simple use cases, trying to use it to render rich text or html is very difficult. Pango is another option that's been around for ages, but both suffer from archaic syntax and minimal rich text support.

Puppeteer, on the other hand, allows for robust, headless chrome screenshots with best-in-class support for all modern html / text / font features.

This CLI makes it easy to use headless chrome to render text + html to images.

Features

  • built-in fontfaceobserver
  • easily load google fonts
  • optional word-wrap
  • main content is just html
  • styling is done via css
  • handles multiple fonts
  • thoroughly tested
  • includes a CLI

Install

npm install -g puppeteer-render-text-cli

Usage

  Usage: puppeteer-render-text [options] <text>
 
  Options:
 
    -V, --version                    output the version number
    -o, --output <path>              path of image file to store result (default: out.png)
    -w, --width <number>             optional max width
    -h, --height <number>            optional max height
    -g, --load-google-font           load font families from google
    -l, --load-font-family <string>  font family to load with fontfaceobserver
    -s, --style <string>             JSON string of CSS styles (default: { })
    --font-family <string>           font-family to add to style
    --font-size <string>             font-size to add to style
    --padding <string>               padding to add to style
    --color <string>                 color to add to style
    -h, --help                       output usage information

Related

License

MIT © Travis Fischer

Install

npm i puppeteer-render-text-cli

DownloadsWeekly Downloads

2

Version

1.0.1

License

MIT

Unpacked Size

6.51 kB

Total Files

10

Last publish

Collaborators

  • avatar