Custom font providing the iconography for Founders4Schools. Made from SVG images coming from flaticon.com and from around the web. See available icons on the (very basic) example page.
This is bower and npm installable using the github shorthand:
bower install --save founders4schools/iconfont4schools
npm install --save founders4schools/iconfont4schools
yarn add founders4schools/iconfont4schools
The font is build with gulp-iconfont. You can get all the needed dependencies with NPM:
npm install
It takes just 2 steps:
- Get a SVG version of the image, and save it to
assets/icons/with clean and unique name. - Run
gulp build(there is also awatchtask), which does the hard work:- Assign a character and add a prefix to your new icon.
- Generating font files under
fonts/ - Generating CSS file under
css/ - Minify CSS file for you
- Generating the updated example page
- Open
examples/index.htmland verify that your new icon is present and renders as expected
The package is just meant to be referenced from the Github shorthand, you just need to create a tag on Github, but make sure to keep a clean versioning:
- Fixing bug with icon: increase patch digit
- New icon: increase the minor digit
- Breaking change: increase major digit
We use version-bump-prompt for that,
which is installed locally. You can run it directly with npx:
npx bump [major|minor|patch] --commit --tag
As you might expect this will commit & tag your new version. Omit the commit/tag options if you want to look at what's going on. Once it looks good, push your changes with the tag you just created.