https://github.com/shaneriley/all_the_faves
Renders varying sized favicons based on a large source image
https://github.com/shaneriley/all_the_faves
Last synced: 3 months ago
JSON representation
Renders varying sized favicons based on a large source image
- Host: GitHub
- URL: https://github.com/shaneriley/all_the_faves
- Owner: shaneriley
- Created: 2013-10-08T19:18:27.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-10-14T14:14:28.000Z (over 11 years ago)
- Last Synced: 2025-01-18T17:24:21.571Z (5 months ago)
- Language: CSS
- Homepage: http://shaneriley.com/all_the_faves/
- Size: 109 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# All the Faves
## Renders varying sized favicons based on a large source image
The plugin, by default, renders four icons that correspond to the four icon
sizes that various iOS devices use. You can pass a different set of widths
at the time you call render.
The plugin looks for an element with a rel attribute of base_icon and expects
it to have an href attribute pointing to the base image to work from. Ideally
you would create a link tag in your head like this:
```html
```
Note that the tried and true 16x16 version is not generated, and should not be.
This should be handled manually, as the reduction in size most often leads to
a blurry mess rather than a recognizable favicon.
## Usage
```javascript
AllTheFaves.render();
```
## Options
You probably won't have to override these, but in the event you want to change
the sizes output, the rel attributes, or the selector used to find the base
image, you can override them like so:
```javascript
AllTheFaves.render({
sizes: [{
side: 256,
rel: "shortcut icon"
}, 144, 114, 72, 57],
default_rel: "android-icon",
selector: "[rel=my_icon]"
});
```
## Favicon.ico
This plugin does not auto-generate an ico file for you. If you need to do this
and can install [ImageMagick](http://www.imagemagick.org/script/index.php),
gather up your icon sizes in PNG format (16x16, 32x32, 48x48, 64x64, 128x128)
and from the path that the images reside, run
`convert favicon.ico`, where filename_1 to
filename_n is a space separated list of the file names.