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

@stefanprobst/favicons

v2.4.0

Published

## How to use

Downloads

48

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

stefanprobststefanprobst

Keywords

Readme

Generate favicons

How to use

npx generate-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:

npx generate-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);
}