mirror of
https://github.com/simple-icons/simple-icons.git
synced 2024-12-16 01:10:30 +02:00
6ee6ba977c
* Add prepublish script
Compiles icons into both static js files (icons/{filename}.js) and
into a static index.js. The latter is not tree-shakeable.
Closes #941, closes #751
* Add information on tree-shaking to README
* Remove index.js after publishing
* Change 'prepublish' to 'prepublishOnly'
* Link to webpack in README
* Simplify postpublish cleanup
Thanks @ericcornelissen
* Fix quote usage in prepublish.js
* Fix quote usage in utils.js
* Optimized file size of prepublish output
* Improved readability of prepublish script
77 lines
2.6 KiB
Markdown
77 lines
2.6 KiB
Markdown
<p align="center">
|
|
<a href="https://simpleicons.org/">
|
|
<img src="https://simpleicons.org/icons/simpleicons.svg" alt="Simple Icons" width=64 height=64>
|
|
</a>
|
|
<h3 align="center">Simple Icons</h3>
|
|
<p align="center">
|
|
Free SVG icons for popular brands. See them all on one page at <a href="https://simpleicons.org">SimpleIcons.org</a>. Contributions, corrections & requests can be made on GitHub. Started by <a href="https://twitter.com/bathtype">Dan Leech</a>.</p>
|
|
</p>
|
|
|
|
## Usage
|
|
|
|
### General Usage
|
|
|
|
Icons can be downloaded as SVGs directly from [our website](https://simpleicons.org/) - simply click the icon you want, and the download should start automatically.
|
|
|
|
### CDN Usage
|
|
|
|
Icons can be served from a CDN such as [JSDelivr](https://www.jsdelivr.com/package/npm/simple-icons) or [Unpkg](https://unpkg.com). Simply use the `simple-icons` npm package and specify a version in the URL like the following:
|
|
|
|
```html
|
|
<img height="32" width="32" src="https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/stackoverflow.svg" />
|
|
<img height="32" width="32" src="https://unpkg.com/simple-icons@latest/icons/stackoverflow.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:
|
|
|
|
```javascript
|
|
const simpleIcons = require('simple-icons');
|
|
|
|
console.log(simpleIcons['Google+']);
|
|
|
|
/*
|
|
{
|
|
title: 'Google+',
|
|
hex: 'DC4E41',
|
|
source: 'https://developers.google.com/+/branding-guidelines',
|
|
svg: '<svg aria-labelledby="simpleicons-googleplus-icon" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">...</svg>'
|
|
}
|
|
*/
|
|
```
|
|
|
|
Alternatively you can import the needed icons individually.
|
|
This is useful if you are e.g. compiling your code with [webpack](https://webpack.js.org/) and therefore have to be mindful of your package size:
|
|
|
|
```js
|
|
const googleplus = require('simple-icons/icons/googleplus');
|
|
|
|
console.log(googleplus);
|
|
/*
|
|
{
|
|
title: 'Google+',
|
|
hex: 'DC4E41',
|
|
source: 'https://developers.google.com/+/branding-guidelines',
|
|
svg: '<svg aria-labelledby="simpleicons-googleplus-icon" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">...</svg>'
|
|
}
|
|
*/
|
|
```
|
|
|
|
## Third Party Extensions
|
|
|
|
### WordPress
|
|
|
|
Icons are also available on WordPress through a simple plugin created by [@tjtaylo](https://github.com/tjtaylo), which you can find [here](https://wordpress.org/plugins/simple-icons/).
|
|
|
|
## Status
|
|
|
|
[](https://travis-ci.org/simple-icons/simple-icons)
|
|
[](https://www.npmjs.com/package/simple-icons)
|