0.1.1 • Published 6 years ago

grunt-google-fontface v0.1.1

Weekly downloads
1
License
-
Repository
github
Last release
6 years ago

grunt-google-fontface

Fetch CSS files of fonts from Google.

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-google-fontface --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-google-fontface');

Google Fontface

Overview

Google Fonts is a good web site which you can get many beautiful custom fonts. You can reference them from Google Fonts directly or download them (TTF files) to your local storage then reference them. In the second case, you have to configure CSS files which contain @font-face definitions for your local TTF files. This plugin will fetch these CSS configurations from Google Fonts and modify them to satisfy your needs.

Options

url

Type: String Default value: https://fonts.googleapis.com/css

The URL which you can fetch CSS files for your TTF files, although I think you won't change this option in most cases.

Usage Examples

Generate a single CSS file

In this example, running google_fontface:single_file will generate a single CSS file which contains all @font-face definitions for your TTF files downloaded from Google Fonts.

grunt.initConfig({
    google_fontface: {
        single_file: {
            src: 'test/font/**/*.ttf',
            dest: 'test/css/font.css'
        }
    }
});

Generate a CSS file for each font

The font files you download from Google Fonts are placed in different directories based on font name, so all TTF files related to a font are in the same directory. In this example, running google_fontface:multiple_files will generate a CSS file which contains @font-face definitions for each font (directory).

grunt.initConfig({
    google_fontface: {
        multiple_files: {
            src: 'test/font/**/*.ttf',
            dest: 'test/css/font/'
        }
    }
});

NOTE: The type of dest is directory instead of file.

Generate a directory contains CSS files for each font

In this example, running google_fontface:multiple_files will generate a directory which contains CSS files for each font. Each TTF file you download from Google Fonts will have a CSS file contains its @font-face definition.

grunt.initConfig({
    google_fontface: {
        multiple_directories: {
            expand: true,
            cwd: 'test/font/',
            src: '**/*.ttf',
            dest: 'test/css/',
            extDot: 'last',
            ext: '.css'
        }
    }
});