# favicons-webpack-plugin-cesco
> Let webpack generate all your favicons and icons for you
Latest version **0.0.6** (published 2017-07-21) · MIT license · 0 weekly downloads
## Install
```sh
npm install favicons-webpack-plugin-cesco
pnpm add favicons-webpack-plugin-cesco
yarn add favicons-webpack-plugin-cesco
bun add favicons-webpack-plugin-cesco
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.0.6 |
| Published | 2017-07-21 |
| First published | 2017-07-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jan Nicklas |
| Maintainers | cescoferraro |
| Keywords | webpack, plugin, html-webpack-plugin, favicon, icon |
## Links
- npm: https://www.npmjs.com/package/favicons-webpack-plugin-cesco
- Repository: https://github.com/cescoferraro/favicons-webpack-plugin
- Issues: https://github.com/cescoferraro/favicons-webpack-plugin/issues
- npm.io page: https://npm.io/package/favicons-webpack-plugin-cesco
## Dependencies (3)
- [webpack](https://npm.io/package/webpack.md) ^1.13.0
- [favicons](https://npm.io/package/favicons.md) ^4.8.6
- [loader-utils](https://npm.io/package/loader-utils.md) ^0.2.14
## Alternatives
- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads
## Recent versions
- 0.0.6 (latest) — 2017-07-21
- 0.0.4 — 2017-07-21
## README
Favicons Webpack Plugin
========================================
[](http://badge.fury.io/js/favicons-webpack-plugin) [](https://david-dm.org/jantimon/favicons-webpack-plugin) [](https://travis-ci.org/jantimon/favicons-webpack-plugin) [](https://github.com/Flet/semistandard)
Allows to use the [favicons](https://github.com/haydenbleasel/favicons) generator with webpack
Installation
------------
You must be running webpack on node 4.4.x or higher
Install the plugin with npm:
```shell
$ npm install --save-dev favicons-webpack-plugin
```
Basic Usage
-----------
Add the plugin to your webpack config as follows:
```javascript
let FaviconsWebpackPlugin = require('favicons-webpack-plugin')
...
plugins: [
new FaviconsWebpackPlugin('my-logo.png')
]
```
This basic configuration will generate [37 different icons](https://github.com/jantimon/favicons-webpack-plugin/tree/master/test/fixtures/expected/default/icons-366a3768de05f9e78c392fa62b8fbb80) 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](https://github.com/jantimon/favicons-webpack-plugin/blob/master/test/fixtures/expected/generate-html/iconstats.json) for you.
If you are using with [html-webpack-plugin](https://github.com/ampedandwired/html-webpack-plugin) it will also inject the necessary html for you:
https://github.com/jantimon/favicons-webpack-plugin/blob/master/test/fixtures/expected/default-with-html/index.html
```html
...
...
```
Advanced Usage
-----------
```javascript
plugins: [
new FaviconsWebpackPlugin({
// 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,
// favicons config (see https://github.com/haydenbleasel/favicons#usage)
config: {
appName: 'App Name',
appDescription: 'App description',
appleStatusBarStyle: 'black-translucent',
background: "#fff",
theme_color: "#fff",
lang: 'en-US',
display: "standalone",
orientation: "portrait",
start_url: "/?homescreen=1",
icons: {
android: true, // Create Android homescreen icon. `boolean` or `{ offset, background, shadow }`
appleIcon: true, // Create Apple touch icons. `boolean` or `{ offset, background }`
appleStartup: true, // Create Apple startup images. `boolean` or `{ offset, background }`
coast: { offset: 25 }, // Create Opera Coast icon with offset 25%. `boolean` or `{ offset, background }`
favicons: true, // Create regular favicons. `boolean`
firefox: true, // Create Firefox OS icons. `boolean` or `{ offset, background }`
windows: true, // Create Windows 8 tile icons. `boolean` or `{ background }`
yandex: true // Create Yandex browser icon. `boolean` or `{ background }`
}
}
})
]
```
# Changelog
Take a look at the [CHANGELOG.md](https://github.com/jantimon/favicons-webpack-plugin/tree/master/CHANGELOG.md).
# Contribution
You're free to contribute to this project by submitting [issues](https://github.com/jantimon/favicons-webpack-plugin/issues) and/or [pull requests](https://github.com/jantimon/favicons-webpack-plugin/pulls). 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](https://github.com/Flet/semistandard).
# License
This project is licensed under [MIT](https://github.com/jantimon/favicons-webpack-plugin/blob/master/LICENSE).
---
_Source: https://npm.io/package/favicons-webpack-plugin-cesco · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._