Skip to content

Latest commit

 

History

History
103 lines (89 loc) · 3.08 KB

README.md

File metadata and controls

103 lines (89 loc) · 3.08 KB

Google Fonts Plugin

Webpack plugin that downloads fonts from Google Fonts and encodes them to base64.

Supports various font formats, currently eot, ttf, woff and woff2.

Exports to format specific and minified css files, which you can serve to your clients.

Install

npm i -D google-fonts-plugin

Usage

webpack.config.js
const GoogleFontsPlugin = require('google-fonts-plugin').default

module.exports = {
  plugins: {
    new GoogleFontsPlugin({
        /* options */
    })
  }
}
webpack.config.js
const GoogleFontsPlugin = require('google-fonts-plugin').default

module.exports = {
  plugins: {
    new GoogleFontsPlugin('path/to/config.json')
  }
}

Options

Plugin supports configuration in javascript object, json or neon file and also in your package.json.

Name Type Default Description
fonts Font[] Roboto Defines which fonts and it's variants and subsets to download
formats String[] eot, ttf, woff, woff2 Specifies which formats to download
outputDir String public/fonts Specifies the output directory
encode Boolean true Whether should encode to base64
minify Boolean true Whether should minify resulting css
Font object
Name Type Default Description
family String Roboto Sets the font family
variants String[] 400, 400i, 700, 700i Sets the variants of the font family to download, note that not all fonts have the all the possible variants
subsets String[] latin-ext Sets the subsets, note that not all fonts are available in all subsets

Example configuration

config.json
{
	"google-fonts-plugin": {
		"fonts": [
			{
				"family": "Roboto",
				"variants": [
					"400",
					"400i",
					"700",
					"700i"
				],
				"subsets": [
					"latin-ext"
				]
			}
		],
		"formats": [
			"woff",
			"woff2"
		],
		"outputDir": "public/fonts"
	}
}
config.neon
google-fonts-plugin:
	fonts: 
		- 
			family: Roboto
			variants:
				- 400
				- 400i
				- 700
				- 700i
			subsets:
				- latin-ext
	formats: 
		- woff
		- woff2
	outputDir: public/fonts