https://github.com/anarmawala/vite-plugin-icons

A plugin to automatically generate favicons and png icons in different sizes.
https://github.com/anarmawala/vite-plugin-icons

Last synced: about 2 months ago
JSON representation

A plugin to automatically generate favicons and png icons in different sizes.

• Host: GitHub
• URL: https://github.com/anarmawala/vite-plugin-icons
• Owner: anarmawala
• License: mit
• Created: 2021-05-17T19:18:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-05-17T20:52:26.000Z (over 3 years ago)
• Last Synced: 2024-11-02T16:06:11.963Z (2 months ago)
• Language: TypeScript
• Size: 327 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        








# @anarmawala/vite-plugin-icons

Simple and straightforward icon generation tool for web applications using Vite

## Features

 - Create PNG icon file in multiple sizes from a single SVG File

 - Custom icon name prefixing

 - Automatically injects icon links into the HTML

 - **WIP:** Allowing for custom sizing and naming

## Usage

**Install the package through NPM or Yarn:**

`npm i @anarmawala/vite-plugin-icons`

or

`yarn add @anarmawala/vite-plugin-icons` if you are using Yarn.

**Add it to your `vite.config.js`**

```ts

// vite.config.js

import { LoadIcon } from '@anarmawala/vite-plugin-icons'

export default {

  plugins: [

    // ... other plugins

    LoadIcon({src: path.resolve(__dirname, 'logo.svg')})

  ]

}

```

## License

MIT License © 2021 [Arshad Narmawala](https://github.com/anarmawala)