middleman-targets 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Rakefile +21 -0
- data/documentation_project/Gemfile +1 -1
- data/documentation_project/config.rb +1 -1
- data/documentation_project/source/helpers-resources.html.md.erb +3 -6
- data/documentation_project/source/partials/config.erb +334 -288
- data/documentation_project/source/partials/helpers.erb +204 -322
- data/documentation_project/source/partials/helpers_extended.erb +139 -0
- data/documentation_project/source/partials/resources.erb +88 -78
- data/lib/middleman-targets/extension.rb +4 -1
- data/lib/middleman-targets/version.rb +1 -1
- data/yard/readme.md +3 -3
- data/yard/template-grouped/default/module/html/method_details_list.erb +11 -0
- data/yard/template-partials/default/method_details/setup.rb +4 -0
- data/yard/template-partials/default/module/html/method_details_list.erb +11 -0
- data/yard/template-partials/default/module/setup.rb +6 -0
- data/yard/template-partials/default/onefile/html/layout.erb +1 -0
- data/yard/template-partials/default/onefile/html/setup.rb +4 -0
- data/yard/yard_extensions.rb +86 -49
- metadata +10 -11
- data/yard/templates/default/fulldoc/html/css/common.css +0 -1
- data/yard/templates/default/fulldoc/html/css/full_list.css +0 -57
- data/yard/templates/default/fulldoc/html/css/style.css +0 -343
- data/yard/templates/default/onefile/html/files.erb +0 -5
- data/yard/templates/default/onefile/html/headers.erb +0 -6
- data/yard/templates/default/onefile/html/layout.erb +0 -17
- data/yard/templates/default/onefile/html/readme.erb +0 -3
- data/yard/templates/default/onefile/html/setup.rb +0 -61
|
@@ -1,354 +1,236 @@
|
|
|
1
|
-
<div class="method_details_list">
|
|
2
|
-
<div class="method_details first">
|
|
3
|
-
<h3 class="signature first" id="image_tag-instance_method">
|
|
4
1
|
|
|
5
|
-
- (<tt>Void</tt>) <strong>image_tag</strong>(path, params = {})
|
|
6
2
|
|
|
7
3
|
|
|
8
4
|
|
|
9
5
|
|
|
6
|
+
<div class="method_details_list">
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
<h2>Helpers</h2>
|
|
10
|
+
|
|
11
|
+
<div class="method_details first">
|
|
12
|
+
<h3 class="signature first" id="target_feature?-instance_method">
|
|
13
|
+
|
|
14
|
+
- (<tt>Boolean</tt>) <strong>target_feature?</strong>(feature)
|
|
15
|
+
|
|
10
16
|
|
|
11
|
-
|
|
12
|
-
<div class="discussion">
|
|
17
|
+
|
|
13
18
|
|
|
14
|
-
|
|
15
|
-
|
|
19
|
+
|
|
20
|
+
</h3><div class="docstring">
|
|
21
|
+
<div class="discussion">
|
|
22
|
+
<p>Does the target have the feature <code>feature</code> enabled?</p>
|
|
16
23
|
|
|
17
|
-
<ul>
|
|
18
|
-
<li>Automatic target-specific images. Note that this
|
|
19
|
-
only works on local files, and only if enabled
|
|
20
|
-
with the option <code>:target_magic_images</code>.</li>
|
|
21
|
-
<li>Target and feature dependent images using the
|
|
22
|
-
<code>params</code> hash.</li>
|
|
23
|
-
<li>Absolute paths, which Middleman sometimes bungles.</li>
|
|
24
|
-
</ul>
|
|
25
24
|
|
|
26
|
-
<p>Note that in addition to the options described below,
|
|
27
|
-
<code>middleman-targets</code> inherits all of the built-in
|
|
28
|
-
option parameters as well.</p>
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
</div>
|
|
32
|
-
</div>
|
|
33
|
-
<div class="tags">
|
|
34
|
-
<p class="tag_title">Parameters:</p>
|
|
35
|
-
<ul class="param">
|
|
36
|
-
|
|
37
|
-
<li>
|
|
38
|
-
|
|
39
|
-
<span class='name'>path</span>
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
—
|
|
47
|
-
<div class='inline'><p>The path to the image file.</p>
|
|
48
|
-
</div>
|
|
49
|
-
|
|
50
|
-
</li>
|
|
51
|
-
|
|
52
|
-
<li>
|
|
53
|
-
|
|
54
|
-
<span class='name'>params</span>
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
—
|
|
64
|
-
<div class='inline'><p>Optional parameters to pass to
|
|
65
|
-
the helper.</p>
|
|
66
|
-
</div>
|
|
67
|
-
|
|
68
|
-
</li>
|
|
69
|
-
|
|
70
|
-
</ul>
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
78
|
-
<ul class="option">
|
|
79
|
-
|
|
80
|
-
<li>
|
|
81
|
-
<span class="name">:target</span>
|
|
82
|
-
<span class="type">(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
83
|
-
<span class="default">
|
|
84
|
-
|
|
85
|
-
</span>
|
|
86
|
-
|
|
87
|
-
— <div class='inline'><p>This image
|
|
88
|
-
tag will only be applied if the current target is
|
|
89
|
-
<code>target</code>.</p>
|
|
90
|
-
</div>
|
|
91
|
-
|
|
92
|
-
</li>
|
|
93
|
-
|
|
94
|
-
<li>
|
|
95
|
-
<span class="name">:feature</span>
|
|
96
|
-
<span class="type">(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
97
|
-
<span class="default">
|
|
98
|
-
|
|
99
|
-
</span>
|
|
100
|
-
|
|
101
|
-
— <div class='inline'><p>This image
|
|
102
|
-
tag will only be applied if the current target
|
|
103
|
-
enables the feature <code>feature</code>.</p>
|
|
104
|
-
</div>
|
|
105
|
-
|
|
106
|
-
</li>
|
|
107
|
-
|
|
108
|
-
</ul>
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
<p class="tag_title">Returns:</p>
|
|
112
|
-
<ul class="return">
|
|
113
|
-
|
|
114
|
-
<li>
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
<span class='type'>(<tt>Void</tt>)</span>
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
</li>
|
|
122
|
-
|
|
123
|
-
</ul>
|
|
124
|
-
|
|
125
|
-
</div>
|
|
126
|
-
</div>
|
|
127
|
-
|
|
128
|
-
<div class="method_details ">
|
|
129
|
-
<h3 class="signature " id="target_feature?-instance_method">
|
|
130
|
-
|
|
131
|
-
- (<tt>Boolean</tt>) <strong>target_feature?</strong>(feature)
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
</h3><div class="docstring">
|
|
138
|
-
<div class="discussion">
|
|
139
|
-
|
|
140
|
-
<p>Does the target have the feature <code>feature</code> enabled?</p>
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
</div>
|
|
144
|
-
</div>
|
|
145
|
-
<div class="tags">
|
|
146
|
-
<p class="tag_title">Parameters:</p>
|
|
147
|
-
<ul class="param">
|
|
148
|
-
|
|
149
|
-
<li>
|
|
150
|
-
|
|
151
|
-
<span class='name'>feature</span>
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
—
|
|
159
|
-
<div class='inline'><p>Specifies a proposed
|
|
160
|
-
feature.</p>
|
|
161
|
-
</div>
|
|
162
|
-
|
|
163
|
-
</li>
|
|
164
|
-
|
|
165
|
-
</ul>
|
|
166
|
-
|
|
167
|
-
<p class="tag_title">Returns:</p>
|
|
168
|
-
<ul class="return">
|
|
169
|
-
|
|
170
|
-
<li>
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
—
|
|
178
|
-
<div class='inline'><p>Returns <code>true</code> if the current target
|
|
179
|
-
has the features <code>feature</code> and the features is
|
|
180
|
-
enabled.</p>
|
|
181
|
-
</div>
|
|
182
|
-
|
|
183
|
-
</li>
|
|
184
|
-
|
|
185
|
-
</ul>
|
|
186
|
-
|
|
187
|
-
</div>
|
|
188
|
-
</div>
|
|
189
|
-
|
|
190
|
-
<div class="method_details ">
|
|
191
|
-
<h3 class="signature " id="target_name-instance_method">
|
|
192
|
-
|
|
193
|
-
- (<tt>Symbol</tt>) <strong>target_name</strong>
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
</h3><div class="docstring">
|
|
200
|
-
<div class="discussion">
|
|
201
|
-
|
|
202
|
-
<p>Return the current build target.</p>
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
</div>
|
|
206
25
|
</div>
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
26
|
+
</div>
|
|
27
|
+
<div class="tags">
|
|
28
|
+
<p class="tag_title">Parameters:</p>
|
|
29
|
+
<ul class="param">
|
|
30
|
+
|
|
31
|
+
<li>
|
|
32
|
+
|
|
33
|
+
<span class='name'>feature</span>
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
—
|
|
41
|
+
<div class='inline'><p>Specifies a proposed
|
|
42
|
+
feature.</p>
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
</li>
|
|
46
|
+
|
|
47
|
+
</ul>
|
|
48
|
+
|
|
49
|
+
<p class="tag_title">Returns:</p>
|
|
50
|
+
<ul class="return">
|
|
51
|
+
|
|
52
|
+
<li>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
—
|
|
60
|
+
<div class='inline'><p>Returns <code>true</code> if the current target
|
|
61
|
+
has the features <code>feature</code> and the features is
|
|
62
|
+
enabled.</p>
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
</li>
|
|
66
|
+
|
|
67
|
+
</ul>
|
|
217
68
|
|
|
69
|
+
</div>
|
|
70
|
+
</div>
|
|
71
|
+
|
|
72
|
+
<div class="method_details ">
|
|
73
|
+
<h3 class="signature " id="target_name-instance_method">
|
|
74
|
+
|
|
75
|
+
- (<tt>Symbol</tt>) <strong>target_name</strong>
|
|
76
|
+
|
|
218
77
|
|
|
219
|
-
|
|
220
|
-
<div class='inline'><p>Returns the current build target.</p>
|
|
221
|
-
</div>
|
|
78
|
+
|
|
222
79
|
|
|
223
|
-
|
|
80
|
+
|
|
81
|
+
</h3><div class="docstring">
|
|
82
|
+
<div class="discussion">
|
|
83
|
+
<p>Return the current build target.</p>
|
|
224
84
|
|
|
225
|
-
</ul>
|
|
226
85
|
|
|
227
|
-
</div>
|
|
228
86
|
</div>
|
|
87
|
+
</div>
|
|
88
|
+
<div class="tags">
|
|
89
|
+
|
|
90
|
+
<p class="tag_title">Returns:</p>
|
|
91
|
+
<ul class="return">
|
|
92
|
+
|
|
93
|
+
<li>
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
—
|
|
101
|
+
<div class='inline'><p>Returns the current build target.</p>
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
</li>
|
|
105
|
+
|
|
106
|
+
</ul>
|
|
229
107
|
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
|
|
111
|
+
<div class="method_details ">
|
|
112
|
+
<h3 class="signature " id="target_name?-instance_method">
|
|
113
|
+
|
|
114
|
+
- (<tt>Boolean</tt>) <strong>target_name?</strong>(proposal)
|
|
115
|
+
|
|
238
116
|
|
|
239
|
-
|
|
240
|
-
<div class="discussion">
|
|
117
|
+
|
|
241
118
|
|
|
242
|
-
|
|
119
|
+
|
|
120
|
+
</h3><div class="docstring">
|
|
121
|
+
<div class="discussion">
|
|
122
|
+
<p>Is the current target <code>proposal</code>?</p>
|
|
243
123
|
|
|
244
124
|
|
|
245
|
-
</div>
|
|
246
125
|
</div>
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
126
|
+
</div>
|
|
127
|
+
<div class="tags">
|
|
128
|
+
<p class="tag_title">Parameters:</p>
|
|
129
|
+
<ul class="param">
|
|
130
|
+
|
|
131
|
+
<li>
|
|
132
|
+
|
|
133
|
+
<span class='name'>proposal</span>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
—
|
|
141
|
+
<div class='inline'><p>Specifies a proposed
|
|
142
|
+
target.</p>
|
|
143
|
+
</div>
|
|
144
|
+
|
|
145
|
+
</li>
|
|
146
|
+
|
|
147
|
+
</ul>
|
|
148
|
+
|
|
149
|
+
<p class="tag_title">Returns:</p>
|
|
150
|
+
<ul class="return">
|
|
151
|
+
|
|
152
|
+
<li>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
—
|
|
160
|
+
<div class='inline'><p>Returns <code>true</code> if the current target
|
|
161
|
+
matches the parameter <code>proposal</code>.</p>
|
|
162
|
+
</div>
|
|
163
|
+
|
|
164
|
+
</li>
|
|
165
|
+
|
|
166
|
+
</ul>
|
|
277
167
|
|
|
168
|
+
</div>
|
|
169
|
+
</div>
|
|
170
|
+
|
|
171
|
+
<div class="method_details ">
|
|
172
|
+
<h3 class="signature " id="target_value-instance_method">
|
|
173
|
+
|
|
174
|
+
- (<tt>String</tt>, <tt>Nil</tt>) <strong>target_value</strong>(key)
|
|
175
|
+
|
|
278
176
|
|
|
279
|
-
|
|
280
|
-
<div class='inline'><p>Returns <code>true</code> if the current target
|
|
281
|
-
matches the parameter <code>proposal</code>.</p>
|
|
282
|
-
</div>
|
|
177
|
+
|
|
283
178
|
|
|
284
|
-
|
|
179
|
+
|
|
180
|
+
</h3><div class="docstring">
|
|
181
|
+
<div class="discussion">
|
|
182
|
+
<p>Attempts to return arbitrary key values for the key
|
|
183
|
+
<code>key</code> for the current target.</p>
|
|
285
184
|
|
|
286
|
-
</ul>
|
|
287
185
|
|
|
288
|
-
</div>
|
|
289
186
|
</div>
|
|
187
|
+
</div>
|
|
188
|
+
<div class="tags">
|
|
189
|
+
<p class="tag_title">Parameters:</p>
|
|
190
|
+
<ul class="param">
|
|
191
|
+
|
|
192
|
+
<li>
|
|
193
|
+
|
|
194
|
+
<span class='name'>key</span>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
—
|
|
202
|
+
<div class='inline'><p>Specifies the desired key
|
|
203
|
+
to look up.</p>
|
|
204
|
+
</div>
|
|
205
|
+
|
|
206
|
+
</li>
|
|
207
|
+
|
|
208
|
+
</ul>
|
|
209
|
+
|
|
210
|
+
<p class="tag_title">Returns:</p>
|
|
211
|
+
<ul class="return">
|
|
212
|
+
|
|
213
|
+
<li>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
<span class='type'>(<tt>String</tt>, <tt>Nil</tt>)</span>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
—
|
|
221
|
+
<div class='inline'><p>Returns the value for <code>key</code> in
|
|
222
|
+
the <code>:targets</code> structure, or <code>nil</code> if it doesn’t
|
|
223
|
+
exist.</p>
|
|
224
|
+
</div>
|
|
225
|
+
|
|
226
|
+
</li>
|
|
227
|
+
|
|
228
|
+
</ul>
|
|
290
229
|
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
</h3><div class="docstring">
|
|
301
|
-
<div class="discussion">
|
|
302
|
-
|
|
303
|
-
<p>Attempts to return arbitrary key values for the key
|
|
304
|
-
<code>key</code> for the current target.</p>
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
</div>
|
|
230
|
+
</div>
|
|
231
|
+
</div>
|
|
232
|
+
|
|
233
|
+
|
|
308
234
|
</div>
|
|
309
|
-
<div class="tags">
|
|
310
|
-
<p class="tag_title">Parameters:</p>
|
|
311
|
-
<ul class="param">
|
|
312
235
|
|
|
313
|
-
<li>
|
|
314
236
|
|
|
315
|
-
<span class='name'>key</span>
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
—
|
|
323
|
-
<div class='inline'><p>Specifies the desired key
|
|
324
|
-
to look up.</p>
|
|
325
|
-
</div>
|
|
326
|
-
|
|
327
|
-
</li>
|
|
328
|
-
|
|
329
|
-
</ul>
|
|
330
|
-
|
|
331
|
-
<p class="tag_title">Returns:</p>
|
|
332
|
-
<ul class="return">
|
|
333
|
-
|
|
334
|
-
<li>
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
<span class='type'>(<tt>String</tt>, <tt>Nil</tt>)</span>
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
—
|
|
342
|
-
<div class='inline'><p>Returns the value for <code>key</code> in
|
|
343
|
-
the <code>:targets</code> structure, or <code>nil</code> if it doesn’t
|
|
344
|
-
exist.</p>
|
|
345
|
-
</div>
|
|
346
|
-
|
|
347
|
-
</li>
|
|
348
|
-
|
|
349
|
-
</ul>
|
|
350
|
-
|
|
351
|
-
</div>
|
|
352
|
-
</div>
|
|
353
|
-
|
|
354
|
-
</div>
|