# broccoli-favicon

> Generate favicons and HTML using Favicons package

Latest version **3.0.0** (published 2021-09-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install broccoli-favicon
pnpm add broccoli-favicon
yarn add broccoli-favicon
bun add broccoli-favicon
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2021-09-22 |
| First published | 2015-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^12.0.0 \|\| ^14.0.0 \|\| >=16.0.0 |
| Dependencies | 5 |
| Unpacked size | 6.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Dave Wasmer |
| Maintainers | davewasmer, exelord |
| Keywords | broccoli, plugin, favicons |

## Links

- npm: https://www.npmjs.com/package/broccoli-favicon
- Repository: https://github.com/davewasmer/broccoli-favicon
- Issues: https://github.com/davewasmer/broccoli-favicon/issues
- npm.io page: https://npm.io/package/broccoli-favicon

## Dependencies (5)

- [favicons](https://npm.io/package/favicons.md) ^6.2.2
- [himalaya](https://npm.io/package/himalaya.md) ^1.1.0
- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.2
- [heimdalljs-logger](https://npm.io/package/heimdalljs-logger.md) ^0.1.10
- [broccoli-caching-writer](https://npm.io/package/broccoli-caching-writer.md) ^3.0.3

## 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

- 3.0.0 (latest) — 2021-09-22
- 2.1.2 — 2019-06-11
- 2.1.1 — 2019-06-05
- 2.1.0 — 2019-03-14
- 2.0.0 — 2018-11-17
- 1.0.0 — 2016-06-22
- 1.0.0-beta.2 — 2016-04-14
- 1.0.0-beta.1 — 2016-04-13
- 0.0.3 — 2015-05-23
- 0.0.2 — 2015-05-21

## README

# broccoli-favicon

[![Build Status](https://travis-ci.org/davewasmer/broccoli-favicon.svg?branch=master)](https://travis-ci.org/davewasmer/broccoli-favicon)
[![Dependency Status](https://david-dm.org/davewasmer/broccoli-favicon.svg)](https://david-dm.org/davewasmer/broccoli-favicon.svg)

Takes a single `favicon.png` and outputs various sizes and file formats for favicons for different platforms and devices. Uses [`favicons`](https://github.com/haydenbleasel/favicons), see that projects documentation for details on the full range of support favicon generation.

## Usage

Default configuration values are show below:

```js
import Favicon from "broccoli-favicon";

const outputNode = new Favicon(nodeWithFaviconImage, {
  iconPath: "favicon.png", // The path to the source image in 'nodeWithFaviconImage'

  onSuccess(htmlArray, rawObject) {
    // this method is called once the generator finishes;
    // the first parameter is an array of strings containing
    // the appropriate HTML to use the generated icons
    // and the second argument is a raw object containing serialized html objects
  },

  // The favicons config object is passed directly to the underlying `Favicons` module
  // See https://github.com/haydenbleasel/favicons for details and defaults
  faviconsConfig: {},
});
```

---
_Source: https://npm.io/package/broccoli-favicon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._