@helpscout/icons v0.0.15

hs-icons

Help Scout's Icon font

Built using gulp.

Table of contents

• Requirements
• Getting started
• Updating

Requirements

• Node
• Gulp

Node

If you do not have Node installed on your machine, we recommend installing it using Homebrew.

Run the following command in your command line:

brew install node

Gulp

Help Scout's icon font is compiled using Gulp. See the Getting Started guide for more information.

npm install -g gulp

Getting started

Installing node things

Similar to Bundler, all you have to do is run the following command, which will allow Gulp to do it's thing.

npm install

Updating

Icon font are automatically generated based on the folders and .svg files within the src directory.

Directory naming

The folder's name (e.g. awesome) will be used as the name of the icon font, and will appear in /dist/ once the font is compiled.

File naming

.svg files that are added/removed from directories within /src/ will be added/removed from the compiled fonts. The file name of the .svg file will be used for the class name of the icon in the compiled CSS.

Example:

checkmark.svg -> .icon-checkmark

Building

To build the icon font, execute the following command in your command line:

gulp

This will compile the icon font (eot, svg, ttf, woff, woff2) and other files (.css, .scss, .html, .md). These files can be found in the /dist/ directory.