# gatsby-plugin-favicon

> Gatsby plugin to add favicon for all configurations

Latest version **3.1.6** (published 2019-04-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install gatsby-plugin-favicon
pnpm add gatsby-plugin-favicon
yarn add gatsby-plugin-favicon
bun add gatsby-plugin-favicon
```

## Health

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

Positive: no vulnerabilities.

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

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.6 |
| Published | 2019-04-03 |
| First published | 2017-08-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Julien Blatecky |
| Maintainers | julienblatecky |
| Keywords | gatsby, gatsby-plugin, favicon |

## Links

- npm: https://www.npmjs.com/package/gatsby-plugin-favicon
- Repository: https://github.com/Creatiwity/gatsby-plugin-favicon
- Homepage: https://github.com/Creatiwity/gatsby-plugin-favicon#readme
- Issues: https://github.com/Creatiwity/gatsby-plugin-favicon/issues
- npm.io page: https://npm.io/package/gatsby-plugin-favicon

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [html-react-parser](https://npm.io/package/html-react-parser.md) ^0.6.4
- [favicons-webpack-plugin](https://npm.io/package/favicons-webpack-plugin.md) git+https://github.com/Creatiwity/favicons-webpack-plugin.git#0872de414061baaad0a2853c77ae75bc38b8bbbf

## 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.1.6 (latest) — 2019-04-03
- 3.1.5 — 2018-12-17
- 3.1.4 — 2018-09-04
- 3.1.3 — 2018-09-03
- 3.1.2 — 2018-07-26
- 3.1.1 — 2018-07-26
- 3.1.0 — 2018-07-24
- 3.0.0 — 2018-07-24
- 2.1.1 — 2017-11-30
- 2.0.0 — 2017-11-06
- 1.1.0 — 2017-11-05
- 1.0.0 — 2017-08-08

## README

# gatsby-plugin-favicon

Generates all favicons for Web, Android, iOS, ...

## Install

`yarn add gatsby-plugin-favicon`

or

`npm install --save gatsby-plugin-favicon`

## How to use

1. Include the plugin in your `gatsby-config.js` file.
2. Add a `favicon.png` file in your `src` folder. The recommended size for the
   file is: 1500x1500px.

```javascript
// in gatsby-config.js
plugins: [
  `gatsby-plugin-favicon`
];
```

## Options

Here is a full list of options with their default values you can use to configure this plugin.

```javascript
// in gatsby-config.js
plugins: [
  {
    resolve: `gatsby-plugin-favicon`,
    options: {
      logo: "./src/favicon.png",

      // WebApp Manifest Configuration
      appName: null, // Inferred with your package.json
      appDescription: null,
      developerName: null,
      developerURL: null,
      dir: 'auto',
      lang: 'en-US',
      background: '#fff',
      theme_color: '#fff',
      display: 'standalone',
      orientation: 'any',
      start_url: '/?homescreen=1',
      version: '1.0',

      icons: {
        android: true,
        appleIcon: true,
        appleStartup: true,
        coast: false,
        favicons: true,
        firefox: true,
        yandex: false,
        windows: false
      }
    }
  }
];
```

## Gatsby v1

Starting from v3, this plugin is not compatible anymore with Gatsby v1, you should stick to the version 2.1.1 of this plugin with Gatsby v1.

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