Bud Favicons

Bud.js extension to automatically generate favicons

---

Installation

Install bud-favicons to your project.

Yarn:

1yarn add bud-favicons --dev

npm:

1npm install bud-favicons --save-dev

Configuration

bud-favicons works with zero configuration. But there is a robust and developer friendly configuration API should you need to make a modification to the provided defaults. You can see the full list of options in the favicons documentation.

Default configuration

1const options = {
2  logo: bud.path('resources/images/favicon.svg'),
3  mode: 'webapp',
4  devMode: 'webapp',
5  outputPath: bud.path('public'),
6  favicons: {
7      icons: {
8          android: true,
9          appleIcon: true,
10          appleStartup: true,
11          favicons: true,
12          windows: true,
13          yandex: false,
14      },
15  },
16};

Configuration with bud.favicons.config

You can configure favicons with the bud.favicons method:

1bud.favicons.setup({
2  logo: bud.path('resources/images/favicon.svg'),
3});

OR

1bud.favicons.setup({
2  logo: bud.path('resources/images/favicon.svg'),
3  mode: 'webapp',
4  devMode: 'webapp',
5  outputPath: bud.path('public'),
6  favicons: {
7      background: '#030321',
8      theme_color: '#ffffff',
9      icons: {
10          android: true,
11          appleIcon: true,
12          appleStartup: true,
13          favicons: true,
14          windows: true,
15          yandex: false,
16      },
17  },
18});

Contributing

Contributions are welcome from everyone.

Credits

Bud Favicons is a Itineris Limited project created by Dan Lapteacru.

Full list of contributors can be found here.

License

Bud Favicons is released under the MIT License.