https://github.com/axelrindle/vite-plugin-favicon

💠 Generate favicons
https://github.com/axelrindle/vite-plugin-favicon

favicon favicon-generator favicons vite vite-plugin

Last synced: 3 months ago
JSON representation

💠 Generate favicons

• Host: GitHub
• URL: https://github.com/axelrindle/vite-plugin-favicon
• Owner: axelrindle
• License: mit
• Created: 2023-04-02T10:17:17.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-15T22:10:52.000Z (almost 2 years ago)
• Last Synced: 2025-02-14T14:06:53.668Z (3 months ago)
• Topics: favicon, favicon-generator, favicons, vite, vite-plugin
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@axelrindle/vite-plugin-favicon
• Size: 279 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![CI](https://github.com/axelrindle/vite-plugin-favicon/actions/workflows/ci.yml/badge.svg)](https://github.com/axelrindle/vite-plugin-favicon/actions/workflows/ci.yml)

![npm (scoped)](https://img.shields.io/npm/v/@axelrindle/vite-plugin-favicon)

[![commit style](https://img.shields.io/badge/Commits-Conventional-fa6673?logo=conventional-commits)](https://www.conventionalcommits.org/en/v1.0.0/)

[![changelog style](https://img.shields.io/badge/Keep%20a-Changelog-e05735?logo=keep-a-changelog)](https://keepachangelog.com/en/1.1.0/)

# vite-plugin-favicon

> 💠 Generate favicons

## Install

```

npm i @axelrindle/vite-plugin-favicon

```

## Usage

```js

import favicon from '@axelrindle/vite-plugin-favicon'

import { defineConfig } from 'vite'

export default defineConfig({

    plugins: [

        favicon()

    ]

})

```

## Configuration

### `source`

One or multiple input files.

One input file is enough in most cases.

### `output`

The relative output directory to place the generated files in.

### `generatorOptions`

Options to pass to the underlying generator library.

For reference see https://github.com/itgalaxy/favicons.

## TODO

- automatic index.html injection

## License

[MIT](LICENSE)