1
0
mirror of https://github.com/simple-icons/simple-icons.git synced 2025-01-25 01:32:58 +02:00
Eric Cornelissen 3af76b75d3
Add NPM script to perform SVGO optimization from the repository (#1476)
* Add SVGO as devDependencies and a NPM script to run it

* Update Contributing Guidelines

Change the instructions on how to use SVGO to optimize SVGs to use the 
new dependency and NPM script.

* Add configuration for the NPM command to optimize SVGs

* Specify --precision  in SVGO configuration file

* Update SVGO config ordering of attributes

To be in line with the fact that, as @davidklebanoff pointed out: "most 
(all?) have the attributes in the order of role, viewbox, xmlns 
(alphabetical)"

* Move SVGO --multipass argument to .svgo.yml

* Update SVGO dependency to 1.3.0

Now the force merge option works 🎉

See: https://github.com/svg/svgo/releases/tag/v1.3.0

* Update outdated "blocking" comment
2019-07-15 15:14:50 +01:00
2019-07-15 14:19:25 +02:00
2019-07-15 14:19:25 +02:00
2017-04-27 18:19:18 +01:00
2017-09-11 21:53:21 +02:00
2015-11-02 14:20:14 +00:00
2018-08-10 15:22:29 +02:00

Simple Icons

Simple Icons

Free SVG icons for popular brands. See them all on one page at SimpleIcons.org. Contributions, corrections & requests can be made on GitHub. Started by Dan Leech.

Usage

General Usage

Icons can be downloaded as SVGs directly from our website - simply click the icon you want, and the download should start automatically.

CDN Usage

Icons can be served from a CDN such as JSDelivr or Unpkg. Simply use the simple-icons npm package and specify a version in the URL like the following:

<img height="32" width="32" src="https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/[ICON NAME].svg" />
<img height="32" width="32" src="https://unpkg.com/simple-icons@latest/icons/[ICON NAME].svg" />

Where [ICON NAME] is replaced by the icon name, for example:

<img height="32" width="32" src="https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/simpleicons.svg" />
<img height="32" width="32" src="https://unpkg.com/simple-icons@latest/icons/simpleicons.svg" />

Node Usage

The icons are also available through our npm package. To install, simply run:

$ npm install simple-icons

The API can then be used as follows:

const simpleIcons = require('simple-icons');

console.log(simpleIcons.get('Simple Icons'));

/*
{
    title: 'Simple Icons',
    slug: 'simpleicons',
    hex: '111111',
    source: 'https://simpleicons.org/',
    svg: '<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">...</svg>',
    path: 'M12 12v-1.5c-2.484 ...'
}
*/

Alternatively you can import the needed icons individually. This is useful if you are e.g. compiling your code with webpack and therefore have to be mindful of your package size:

const icon = require('simple-icons/icons/simpleicons');

console.log(icon);

/*
{
    title: 'Simple Icons',
    slug: 'simpleicons',
    hex: '111111',
    source: 'https://simpleicons.org/',
    svg: '<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">...</svg>',
    path: 'M12 12v-1.5c-2.484 ...'
}
*/

Third Party Extensions

WordPress

Icons are also available on WordPress through a simple plugin created by @tjtaylo, which you can find here.

Status

Build Status npm version

Languages
JavaScript 99.8%
Dockerfile 0.2%