Favicons Webpack Plugin
Allows to use the favicons generator with webpack
Installation
You must be running webpack on node 0.12.x or higher
Install the plugin with npm:
$ npm install --save-dev favicons-webpack-plugin
Basic Usage
Add the plugin to your webpack config as follows:
let FaviconsWebpackPlugin = ... plugins: 'my-logo.png'
This basic configuration will generate 37 different icons for iOS devices, Android devices and the Desktop browser out of your my-logo.png
file.
It can optionally also generate a JSON file with all information about the icons for you.
If you are using with html-webpack-plugin it will also inject the necessary html for you:
... ...
Advanced Usage
plugins: // Your source logo logo: 'my-logo.png' // The prefix for all image files (might be a folder or a name) prefix: 'icons-[hash]/' // Emit all stats of the generated icons emitStats: false // The name of the json containing all favicon information statsFilename: 'iconstats-[hash].json' // Generate a cache file with control hashes and // don't rebuild the favicons until those hashes change persistentCache: true // Inject the html into the html-webpack-plugin inject: true // favicon background color (see https://github.com/haydenbleasel/favicons#usage) background: '#fff' // favicon app title (see https://github.com/haydenbleasel/favicons#usage) title: 'Webpack App' // which icons should be generated (see https://github.com/haydenbleasel/favicons#usage) icons: android: true appleIcon: true appleStartup: true coast: false favicons: true firefox: true opengraph: false twitter: false yandex: false windows: false
Changelog
Take a look at the CHANGELOG.md.
Contribution
You're free to contribute to this project by submitting issues and/or pull requests. This project is test-driven, so keep in mind that every change and new feature should be covered by tests. This project uses the semistandard code style.
License
This project is licensed under MIT.