greenwood-plugin-font-awesome

0.1.0 • Public • Published

greenwood-plugin-font-awesome

GitHub release GitHub Actions status GitHub issues GitHub license

Overview

A Greenwood plugin for managing Font Awesome related dependencies and assets for building and development.


This plugin is useful because Font Awesome references its font files relatively.

@font-face {
  font-family: 'FontAwesome';
  src: url('../fonts/fontawesome-webfont.eot?v=4.7.0');
  src: url('../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0') format('embedded-opentype'), url('../fonts/fontawesome-webfont.woff2?v=4.7.0') format('woff2'), url('../fonts/fontawesome-webfont.woff?v=4.7.0') format('woff'), url('../fonts/fontawesome-webfont.ttf?v=4.7.0') format('truetype'), url('../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular') format('svg');
  font-weight: normal;
  font-style: normal;
}

This means that these paths need to be resolved specifically to the right location in node_modules where the Font Awesome package is located. Additionally, this plugin ensures the font files are copied as part of the build process.

Installation

This plugin defines the following peerDependencies, so please make sure you already have them installed first

  • @greenwood/cli@^0.19.0
  • font-awesome@^4.6.3

Install the plugin using your preferred package manager

# npm
$ npm install greenwood-plugin-font-awesome --save-dev

# yarn
$ yarn add greenwood-plugin-font-awesome --dev

Usage

Simply add this to the plugins array of your greenwood.config.js

const greenwoodPluginFontAwesome = require('greenwood-plugin-font-awesome');

module.exports = {
  plugins: [
    ...greenwoodPluginFontAwesome() // notice the spread ... !
  ]
}

Readme

Keywords

Package Sidebar

Install

npm i greenwood-plugin-font-awesome

Weekly Downloads

1

Version

0.1.0

License

MIT

Unpacked Size

5.11 kB

Total Files

3

Last publish

Collaborators

  • thescientist13