@stefanprobst/favicons
TypeScript icon, indicating that this package has built-in type declarations

2.2.2 • Public • Published

Generate favicons

How to use

create-favicons -i [FILE] -o [FOLDER] [...OPTIONS]

Options:

  • -i, --input: path to input file
  • -o, --output: path to output folder
  • -n, --name: name for webmanifest (optional)
  • -s, --short: short name for webmanifest (optional)
  • -c, --color: theme color for webmanifest (optional)
  • -m, --maskable: mark images as maskable (optional)
  • -u, --url: set the start_url path (optional)
  • -h, --help: show help message

If the --color option is not provided, the theme color will be set to the image's dominant color.

Example:

create-favicons -i src/assets/images/logo.svg -o public

The following files are generated:

  • android-chrome-192x192.png (192x192px)
  • android-chrome-512x512.png (512x512px)
  • apple-touch-icon.png (180x180px)
  • favicon-16x16.png (16x16px)
  • favicon-32x32.png (32x32px)
  • favicon.ico (16x16px, 32x32px, 48x48px)

To use the generated favicons, copy them to your site's root folder, and add the following to the <head> element:

<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" />
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png" />
<link rel="manifest" href="/site.webmanifest" />

Note: favicon.ico and the android icons don't need to be referenced explicitly as long as they live in the root folder (the browser will automatically find them there).

How to use in Node.js

It is possible to use the generator programmatically from Node.js:

const generate = require('@stefanprobst/favicons')

async function createFavicons() {
  const stats = await generate({
    inputFilePath,
    outputFolder,
    name,
    shortName,
    color,
    maskable,
    startUrl,
  })
  console.log(stats)
}

Readme

Keywords

none

Package Sidebar

Install

npm i @stefanprobst/favicons

Weekly Downloads

2

Version

2.2.2

License

MIT

Unpacked Size

18.2 kB

Total Files

9

Last publish

Collaborators

  • stefanprobst