parnassys-icons v0.2.2-160420-0752

Repo for universal icon set for parnassys (suite).

How to release:

1. Add new icons to icons folder
2. git commit and push to master

How to use:

Install:

yarn add parnassys-icons

or

npm i parnassys-icons

Depending on your framework you want to flag parnassys-icons in your node_modules as static assets.

The distributed package also contains a const you can import like this:

import { icons } from 'node_modules/parnassys-icons/dist/icons/icons.js';

Which contains all the icon names, depending on your SVG solution you can use this to generate a mapping. Overview of all icons can be found at:

https://zeroheight.com/80091f278/p/1732cd/b/66f1cc

Folders & files

icon-font-templates

Template for our icon font, used by gulp-iconfont-css package

icons

Actual icons

scripts

Contains a script for appending the current time to package.json so we can do nightly builds. Also a script for converting icons to be usable in frontend projects and in a iconfont. Used python for this since I couldn't find a javascript solution.

gulpfile

Gulp is a javascript task runner, used for creating the iconfont.

Jenkinsfile

Automates build and publishes project to npm registry.