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

mkwebmanifest

v0.1.1

Published

Generate icons and web manifest for web applications

Downloads

7

Readme

CI

mkwebmanifest

Generate icons in different sizes and a web manifest, in order to link icons (and make a web application installable).

The web manifest will contain all properties that are required on some platforms (name, icons, start_url, display).

Usage

npx mkwebmanifest --icon app/assets/images/icon.svg --name myapp

or using all settings from a default configuration file location

cat > mkwebmanifest.config.json << EOF
{
  "name": "myapp",
  "icon": "app/assets/images/icon.svg"
}
EOF

npx mkwebmanifest

Or if installed

mkwebmanifest --icon app/assets/images/icon.svg --name myapp

It's recommended to provide an SVG or large PNG (e.g. 512x512) source icon.

Options and Configuration

Only the icon and name settings are required, either as option or configuration. icon is path of the input icon file, name is the name of the application.

If the --name option isn't given, the command assumes a configuration file at one of the default locations.

  • config/mkwebmanifest.json
  • mkwebmanifest.json
  • mkwebmanifest.config.json
  • config/mkwebmanifest.config.json

A configuration file might look like this:

{
  "icon": "app/assets/images/icon-oval.svg",
  "outdir": "app/assets/builds",
  "name": "MyApp. Make my data available on the web while maintaining full control",
  "short_name": "MyApp",
  "description": "MyApp is a tool that makes your current data available while maintaining full control over it"
}

A different configuration file can be set with --config.

Configuration

  • icon (required) - input icon file
  • name (required) - the app name
  • outdir ("./public")
  • short_name - short version of the name
  • display ("browser") - controls if standard browser UI is used, see the standard for details.
  • sizes (512, 192, 180, 168, 144, 96, 72, 48, 32, 16) - which icon sizes to generate from the input icon. The input should be larger than these, or vector based for best results. Use comma-delimited list of sizes (without spaces)
  • description - description of the app
  • webmanifest - provide further properties for the generated web manifest file (only available via configuration file)

Limitations

  • The icon files with the various sizes are all written to a subdirectory in outdir. This subdirectory cannot be configure for now. It's always named 'icons'.

References

1 https://developer.mozilla.org/en-US/docs/Web/Manifest

Credit

Besides the dependencies declared in package.json, test fixtures contain the CheckBadge icon from https://heroicons.dev, used under an MIT license, and a version converted to PNG sized 96x96 px by svgexporter.