Ninja Programmers Mindmeld

    vite-plugin-favicons-inject

    2.1.0 • Public • Published

    vite-plugin-favicons-inject

    npm license

    A Vite plugin for creating and injecting favicons during the application build!

    Install

    $ npm install vite-plugin-favicons-inject

    Usage

    As ES6 Module

    // In vite.config.js file
    
    import vitePluginFaviconsInject from 'vite-plugin-favicons-inject';
    
    export default defineConfig({
      plugins: [
        ...
        vitePluginFaviconsInject('./src/assets/logo.svg'),
        ...
      ]
    });

    As CommonJs

    // In vite.config.js file
    
    const vitePluginFaviconsInject = require('vite-plugin-favicons-inject');
    
    export default defineConfig({
      plugins: [
        ...
        vitePluginFaviconsInject('./src/assets/logo.svg'),
        ...
      ]
    });

    Parameter

    • source - path of the logo file. Default: ./src/logo.png
    • config (optional) - favions config object. (refer favicons for all available options).

    Note 'path' option in the config cannot be overriden as it is assigned to vite assetsDir:

    {
      path: "<vite assets dir>" // destination path of generated favicons based on vite asset dir
    }

    More information about vite assets directory and how to change it can be found here

    Compatibility

    This plugin was created to easily migrate from vite-plugin-favicon which no longer seems to be working.

    Just install, change the import and plugin config in vite config file. You are good to go!

    License

    MIT

    Install

    npm i vite-plugin-favicons-inject

    DownloadsWeekly Downloads

    212

    Version

    2.1.0

    License

    MIT

    Unpacked Size

    225 kB

    Total Files

    9

    Last publish

    Collaborators

    • johnpk