middleman-favicon-maker 3.3 → 3.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/README.md +81 -61
- data/lib/middleman-favicon-maker/extension.rb +1 -1
- data/lib/middleman-favicon-maker/version.rb +2 -2
- data/middleman-favicon-maker.gemspec +1 -1
- metadata +11 -17
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: 4ea8530b747f81bb37285af745a28e9afbbf6839
|
|
4
|
+
data.tar.gz: 2fda3e341b19b0e4641ca26126c37bcfa8b33c65
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: ee2937349abc27e83d203ea5cde1613d64b2a1f97c24b6cb4e8d9963ed2cc40143690fb00888ae67590ff2a9727ec8dc984280dbb4bc27ddced0a89b96493753
|
|
7
|
+
data.tar.gz: f9e07b9ec637f2d0f44c44216befadc282e590cdb3ac03dca7e909e64cb279f1e7e2ff6d9889784e9b1ed6a53f01a247966d0345b42c739e87d017a4197750c1
|
data/README.md
CHANGED
|
@@ -1,85 +1,105 @@
|
|
|
1
|
-
middleman-favicon-maker [](http://travis-ci.org/follmann/middleman-favicon-maker)
|
|
2
|
-
=======================
|
|
3
|
-
Generate favicon files in various sizes from a base image in your [Middleman](http://middlemanapp.com/) project.
|
|
1
|
+
# middleman-favicon-maker [](http://travis-ci.org/follmann/middleman-favicon-maker)
|
|
4
2
|
|
|
5
|
-
|
|
3
|
+
[FaviconMaker](https://github.com/follmann/favicon_maker) is a gem which generates favicon files in various sizes from a base image. This gem integrates FaviconMaker effortlessly into your [Middleman](https://github.com/middleman/middleman) project.
|
|
6
4
|
|
|
7
|
-
##
|
|
5
|
+
## Installation
|
|
8
6
|
|
|
9
|
-
###
|
|
10
|
-
|
|
7
|
+
### Dependencies
|
|
8
|
+
|
|
9
|
+
Before you can use FaviconMaker, you need to install [ImageMagick](http://www.imagemagick.org/script/index.php). On OS X, the easiest way to do this is to run:
|
|
11
10
|
|
|
12
|
-
|
|
11
|
+
``` shell
|
|
12
|
+
brew install imagemagick
|
|
13
|
+
```
|
|
13
14
|
|
|
14
15
|
### Using Bundler (recommended)
|
|
15
|
-
gem "middleman-favicon-maker"
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
17
|
+
``` ruby
|
|
18
|
+
gem "middleman-favicon-maker", "~> 3.2"
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
If you're using Middleman version 2.x, use version 0.0.6 of middleman-favicon-maker.
|
|
22
|
+
|
|
23
|
+
### Standalone
|
|
24
|
+
|
|
25
|
+
``` shell
|
|
26
|
+
gem install middleman-favicon-maker
|
|
27
|
+
```
|
|
20
28
|
|
|
21
|
-
##
|
|
22
|
-
1. Put a file called **favicon_base.png** into your source folder (ideally with the **dimensions of 144x144 pixels**)
|
|
23
|
-
<br><br>
|
|
24
|
-
2. In your config.rb extend the `configure :build` block with:
|
|
29
|
+
## Integrating with Middleman
|
|
25
30
|
|
|
26
|
-
|
|
27
|
-
...
|
|
28
|
-
activate :favicon_maker
|
|
29
|
-
...
|
|
30
|
-
end
|
|
31
|
+
Create a favicon_base.png image and place it in your source directory. Ideally, this image's dimensions would be 144 x 144. In config.rb, extend the `configure :build` block:
|
|
31
32
|
|
|
32
|
-
|
|
33
|
+
``` ruby
|
|
34
|
+
configure :build do
|
|
35
|
+
...
|
|
36
|
+
activate :favicon_maker
|
|
37
|
+
...
|
|
38
|
+
end
|
|
39
|
+
```
|
|
33
40
|
|
|
34
|
-
|
|
35
|
-
build/apple-touch-icon-120x120-precomposed.png
|
|
36
|
-
build/apple-touch-icon-114x114-precomposed.png
|
|
37
|
-
build/apple-touch-icon-72x72-precomposed.png
|
|
38
|
-
build/apple-touch-icon-57x57-precomposed.png
|
|
39
|
-
build/apple-touch-icon-precomposed.png
|
|
40
|
-
build/apple-touch-icon.png
|
|
41
|
-
build/favicon.ico
|
|
42
|
-
build/favicon.png
|
|
41
|
+
When you build your Middleman project, middleman-favicon-maker will generate the following files in your build directory:
|
|
43
42
|
|
|
44
|
-
|
|
43
|
+
* apple-touch-icon-144x144-precomposed.png
|
|
44
|
+
* apple-touch-icon-120x120-precomposed.png
|
|
45
|
+
* apple-touch-icon-114x114-precomposed.png
|
|
46
|
+
* apple-touch-icon-72x72-precomposed.png
|
|
47
|
+
* apple-touch-icon-57x57-precomposed.png
|
|
48
|
+
* apple-touch-icon-precomposed.png
|
|
49
|
+
* apple-touch-icon.png
|
|
50
|
+
* favicon.ico
|
|
51
|
+
* favicon.png
|
|
45
52
|
|
|
46
|
-
|
|
53
|
+
The base image will not be copied into the build folder.
|
|
47
54
|
|
|
48
|
-
|
|
55
|
+
## Customizing middleman-favicon-maker
|
|
49
56
|
|
|
50
|
-
|
|
57
|
+
Version 3.x of this gem uses the `favicon_maker_` prefix for configuration options to be consistent with the activation keyword `:favicon_maker`. Previously the `favicon_` prefix was used.
|
|
51
58
|
|
|
52
|
-
|
|
53
|
-
:favicon_maker_input_dir # default: app.views -> source/
|
|
54
|
-
:favicon_maker_output_dir # default: app.build_dir -> build/
|
|
55
|
-
:favicon_maker_base_image # default: "favicon_base.png"
|
|
56
|
-
:favicon_maker_versions # default: ::FaviconMaker::Generator::ICON_VERSIONS.keys
|
|
57
|
-
:favicon_maker_custom_versions # default: {}
|
|
59
|
+
You can set the following options for middleman-favicon-maker:
|
|
58
60
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
61
|
+
``` ruby
|
|
62
|
+
:favicon_maker_root_dir # default: app.root
|
|
63
|
+
:favicon_maker_input_dir # default: app.views -> source/
|
|
64
|
+
:favicon_maker_output_dir # default: app.build_dir -> build/
|
|
65
|
+
:favicon_maker_base_image # default: "favicon_base.png"
|
|
66
|
+
:favicon_maker_versions # default: [ :fav_png, :fav_ico ]
|
|
67
|
+
:favicon_maker_custom_versions # default: {}
|
|
68
|
+
```
|
|
62
69
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
70
|
+
For example:
|
|
71
|
+
|
|
72
|
+
``` ruby
|
|
73
|
+
activate :favicon_maker,
|
|
74
|
+
:favicon_maker_input_dir =>"favicons"
|
|
75
|
+
:favicon_maker_custom_versions => {:apple_extreme_retina => {:filename => "apple-touch-icon-228x228-precomposed.png", :dimensions => "228x228", :format => "png"}}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Markup meta links
|
|
79
|
+
|
|
80
|
+
Specifying meta links is only necessary if you want to support non-iOS devices. Safari mobile will automatically look for the icon files in the root directory. If you'd like to know more about how this works, check out this great blog post: [Everything you always wanted to know about touch icons](http://mathiasbynens.be/notes/touch-icons)
|
|
66
81
|
|
|
67
82
|
### HTML
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
83
|
+
|
|
84
|
+
``` html
|
|
85
|
+
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="apple-touch-icon-144x144-precomposed.png" />
|
|
86
|
+
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="apple-touch-icon-114x114-precomposed.png" />
|
|
87
|
+
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="apple-touch-icon-72x72-precomposed.png" />
|
|
88
|
+
<link rel="apple-touch-icon-precomposed" href="apple-touch-icon-precomposed.png" />
|
|
89
|
+
<link rel="shortcut icon" href="favicon.png" />
|
|
90
|
+
<link rel="icon" type="image/ico" href="favicon.ico" />
|
|
91
|
+
```
|
|
92
|
+
|
|
75
93
|
### HAML
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
94
|
+
|
|
95
|
+
``` haml
|
|
96
|
+
%link{ rel: "apple-touch-icon", sizes: "144x144", href: "apple-touch-icon-144x144-precomposed.png" }
|
|
97
|
+
%link{ rel: "apple-touch-icon", sizes: "114x114", href: "apple-touch-icon-114x114-precomposed.png" }
|
|
98
|
+
%link{ rel: "apple-touch-icon", sizes: "72x72", href: "apple-touch-icon-72x72-precomposed.png" }
|
|
99
|
+
%link{ rel: "apple-touch-icon", href: "apple-touch-icon-precomposed.png" }
|
|
100
|
+
%link{ rel: "shortcut icon", href: "favicon.png" }
|
|
101
|
+
%link{ rel: "icon", type: "image/ico", href: "favicon.ico" }
|
|
102
|
+
```
|
|
83
103
|
|
|
84
104
|
## Copyright
|
|
85
105
|
|
|
@@ -8,7 +8,7 @@ module Middleman
|
|
|
8
8
|
options[:favicon_maker_input_dir] ||= ''
|
|
9
9
|
options[:favicon_maker_output_dir] ||= ''
|
|
10
10
|
options[:favicon_maker_base_image] ||= 'favicon_base.png'
|
|
11
|
-
options[:favicon_maker_versions] ||=
|
|
11
|
+
options[:favicon_maker_versions] ||= [ :fav_png, :fav_ico ]
|
|
12
12
|
options[:favicon_maker_custom_versions] ||= {}
|
|
13
13
|
|
|
14
14
|
app.after_configuration do
|
metadata
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: middleman-favicon-maker
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
5
|
-
prerelease:
|
|
4
|
+
version: 3.4.1
|
|
6
5
|
platform: ruby
|
|
7
6
|
authors:
|
|
8
7
|
- Andreas Follmann
|
|
@@ -10,40 +9,36 @@ authors:
|
|
|
10
9
|
autorequire:
|
|
11
10
|
bindir: bin
|
|
12
11
|
cert_chain: []
|
|
13
|
-
date:
|
|
12
|
+
date: 2014-01-09 00:00:00.000000000 Z
|
|
14
13
|
dependencies:
|
|
15
14
|
- !ruby/object:Gem::Dependency
|
|
16
15
|
name: middleman-core
|
|
17
16
|
requirement: !ruby/object:Gem::Requirement
|
|
18
|
-
none: false
|
|
19
17
|
requirements:
|
|
20
|
-
- -
|
|
18
|
+
- - '>='
|
|
21
19
|
- !ruby/object:Gem::Version
|
|
22
20
|
version: 3.0.0
|
|
23
21
|
type: :runtime
|
|
24
22
|
prerelease: false
|
|
25
23
|
version_requirements: !ruby/object:Gem::Requirement
|
|
26
|
-
none: false
|
|
27
24
|
requirements:
|
|
28
|
-
- -
|
|
25
|
+
- - '>='
|
|
29
26
|
- !ruby/object:Gem::Version
|
|
30
27
|
version: 3.0.0
|
|
31
28
|
- !ruby/object:Gem::Dependency
|
|
32
29
|
name: favicon_maker
|
|
33
30
|
requirement: !ruby/object:Gem::Requirement
|
|
34
|
-
none: false
|
|
35
31
|
requirements:
|
|
36
32
|
- - ~>
|
|
37
33
|
- !ruby/object:Gem::Version
|
|
38
|
-
version: 0.
|
|
34
|
+
version: '0.3'
|
|
39
35
|
type: :runtime
|
|
40
36
|
prerelease: false
|
|
41
37
|
version_requirements: !ruby/object:Gem::Requirement
|
|
42
|
-
none: false
|
|
43
38
|
requirements:
|
|
44
39
|
- - ~>
|
|
45
40
|
- !ruby/object:Gem::Version
|
|
46
|
-
version: 0.
|
|
41
|
+
version: '0.3'
|
|
47
42
|
description: Generate favicon files in various sizes from a base image in your Middleman
|
|
48
43
|
project
|
|
49
44
|
email:
|
|
@@ -66,27 +61,26 @@ files:
|
|
|
66
61
|
- test/test_middleman-favicon-maker.rb
|
|
67
62
|
homepage: https://github.com/follmann/middleman-favicon-maker
|
|
68
63
|
licenses: []
|
|
64
|
+
metadata: {}
|
|
69
65
|
post_install_message:
|
|
70
66
|
rdoc_options: []
|
|
71
67
|
require_paths:
|
|
72
68
|
- lib
|
|
73
69
|
required_ruby_version: !ruby/object:Gem::Requirement
|
|
74
|
-
none: false
|
|
75
70
|
requirements:
|
|
76
|
-
- -
|
|
71
|
+
- - '>='
|
|
77
72
|
- !ruby/object:Gem::Version
|
|
78
73
|
version: '0'
|
|
79
74
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
80
|
-
none: false
|
|
81
75
|
requirements:
|
|
82
|
-
- -
|
|
76
|
+
- - '>='
|
|
83
77
|
- !ruby/object:Gem::Version
|
|
84
78
|
version: '0'
|
|
85
79
|
requirements: []
|
|
86
80
|
rubyforge_project:
|
|
87
|
-
rubygems_version: 1.
|
|
81
|
+
rubygems_version: 2.1.11
|
|
88
82
|
signing_key:
|
|
89
|
-
specification_version:
|
|
83
|
+
specification_version: 4
|
|
90
84
|
summary: Generate favicon files in various sizes from a base image in your Middleman
|
|
91
85
|
project
|
|
92
86
|
test_files:
|