middleman-pagegroups 1.0.2 → 1.0.3
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/.gitignore +8 -1
- data/.yardopts +8 -0
- data/CHANGELOG.md +24 -4
- data/README.md +5 -5
- data/Rakefile +201 -7
- data/documentation_project/Gemfile +2 -2
- data/documentation_project/config.rb +15 -19
- data/documentation_project/source/documentation/100_nested_folder/another_file.html.md.erb +19 -0
- data/documentation_project/source/documentation/100_nested_folder/index.html.md.erb +25 -0
- data/documentation_project/source/documentation/100_nested_folder/one_file.html.md.erb +11 -0
- data/documentation_project/source/documentation/100_nested_folder/stray.txt +6 -0
- data/documentation_project/source/documentation/10_concepts.html.md.erb +1 -1
- data/documentation_project/source/documentation/20_directory_organization.html.md.erb +12 -10
- data/documentation_project/source/documentation/40_resources.html.md.erb +3 -68
- data/documentation_project/source/documentation/50_helpers.html.md.erb +41 -163
- data/documentation_project/source/documentation/60_sample_partials.html.md.erb +23 -22
- data/documentation_project/source/documentation/80_config.html.md.erb +6 -0
- data/documentation_project/source/documentation/90_cli.html.md.erb +47 -0
- data/documentation_project/source/partials/_yard_config.erb +744 -0
- data/documentation_project/source/partials/_yard_helpers.erb +710 -0
- data/documentation_project/source/partials/_yard_helpers_css.erb +523 -0
- data/documentation_project/source/partials/_yard_helpers_extended.erb +56 -0
- data/documentation_project/source/partials/_yard_resources.erb +540 -0
- data/documentation_project/source/stylesheets/_middlemac_minimal.scss +287 -0
- data/features/helpers_and_resources.feature +120 -0
- data/features/support/env.rb +20 -0
- data/fixtures/middleman_pagegroups_app/config.rb +17 -0
- data/fixtures/middleman_pagegroups_app/source/20_sub_folder_02/index.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/20_sub_folder_02/not_legitimate.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/20_sub_folder_02/sibling_one.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/20_sub_folder_02/sibling_two.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/_partial.md.erb +111 -0
- data/fixtures/middleman_pagegroups_app/source/index.html.md.erb +23 -0
- data/fixtures/middleman_pagegroups_app/source/layout.erb +6 -0
- data/fixtures/middleman_pagegroups_app/source/sub_folder_01/10_sibling_one.html.md.erb +7 -0
- data/fixtures/middleman_pagegroups_app/source/sub_folder_01/20_sibling_two.html.md.erb +7 -0
- data/fixtures/middleman_pagegroups_app/source/sub_folder_01/30_sibling_three.html.md.erb +7 -0
- data/fixtures/middleman_pagegroups_app/source/sub_folder_01/index.html.md.erb +9 -0
- data/lib/middleman-pagegroups/extension.rb +468 -110
- data/lib/middleman-pagegroups/partials.rb +9 -12
- data/lib/middleman-pagegroups/version.rb +1 -1
- data/middleman-pagegroups.gemspec +10 -2
- data/yard/readme.md +5 -0
- 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/attribute_details.erb +9 -0
- data/yard/template-partials/default/module/html/method_details_list.erb +10 -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 +109 -0
- metadata +105 -7
@@ -0,0 +1,523 @@
|
|
1
|
+
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
|
6
|
+
<div class="method_details_list">
|
7
|
+
|
8
|
+
|
9
|
+
|
10
|
+
<div class="method_details first">
|
11
|
+
<h3 class="signature first" id="nav_breadcrumbs_alt_class-instance_method">
|
12
|
+
|
13
|
+
- (<tt>String</tt>) <strong>nav_breadcrumbs_alt_class</strong>
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
|
19
|
+
</h3><div class="docstring">
|
20
|
+
<div class="discussion">
|
21
|
+
<p>Returns the value of the the extension option
|
22
|
+
<code>options[:nav_breadcrumbs_alt_class]</code>.</p>
|
23
|
+
|
24
|
+
<p>Both the built-in helpers and the partials (if you
|
25
|
+
install them) use these helpers in order to access the
|
26
|
+
configuration values. When writing your own partials
|
27
|
+
it is generally unnecessary to use these helpers; you
|
28
|
+
can simply assign your own class name.</p>
|
29
|
+
|
30
|
+
<p>The provided helpers and partials use CSS classes, and
|
31
|
+
if the class names collide with your own class names
|
32
|
+
or fail to meet with your naming standards, then they
|
33
|
+
can be changed using the extension options.</p>
|
34
|
+
|
35
|
+
|
36
|
+
</div>
|
37
|
+
</div>
|
38
|
+
<div class="tags">
|
39
|
+
|
40
|
+
<p class="tag_title">Returns:</p>
|
41
|
+
<ul class="return">
|
42
|
+
|
43
|
+
<li>
|
44
|
+
|
45
|
+
|
46
|
+
<span class='type'>(<tt>String</tt>)</span>
|
47
|
+
|
48
|
+
|
49
|
+
|
50
|
+
—
|
51
|
+
<div class='inline'><p>Returns the name of the class.</p>
|
52
|
+
</div>
|
53
|
+
|
54
|
+
</li>
|
55
|
+
|
56
|
+
</ul>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
</div>
|
60
|
+
|
61
|
+
<div class="method_details ">
|
62
|
+
<h3 class="signature " id="nav_breadcrumbs_alt_label-instance_method">
|
63
|
+
|
64
|
+
- (<tt>String</tt>) <strong>nav_breadcrumbs_alt_label</strong>
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h3><div class="docstring">
|
71
|
+
<div class="discussion">
|
72
|
+
<p>Returns the value of the the extension option
|
73
|
+
<code>options[:nav_breadcrumbs_alt_label]</code>.</p>
|
74
|
+
|
75
|
+
<p>Both the built-in helpers and the partials (if you
|
76
|
+
install them) use these helpers in order to access the
|
77
|
+
configuration values. When writing your own partials
|
78
|
+
it is generally unnecessary to use these helpers; you
|
79
|
+
can simply assign your own class name.</p>
|
80
|
+
|
81
|
+
<p>The provided helpers and partials use CSS classes, and
|
82
|
+
if the class names collide with your own class names
|
83
|
+
or fail to meet with your naming standards, then they
|
84
|
+
can be changed using the extension options.</p>
|
85
|
+
|
86
|
+
|
87
|
+
</div>
|
88
|
+
</div>
|
89
|
+
<div class="tags">
|
90
|
+
|
91
|
+
<p class="tag_title">Returns:</p>
|
92
|
+
<ul class="return">
|
93
|
+
|
94
|
+
<li>
|
95
|
+
|
96
|
+
|
97
|
+
<span class='type'>(<tt>String</tt>)</span>
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
—
|
102
|
+
<div class='inline'><p>Returns the name of the class.</p>
|
103
|
+
</div>
|
104
|
+
|
105
|
+
</li>
|
106
|
+
|
107
|
+
</ul>
|
108
|
+
|
109
|
+
</div>
|
110
|
+
</div>
|
111
|
+
|
112
|
+
<div class="method_details ">
|
113
|
+
<h3 class="signature " id="nav_breadcrumbs_class-instance_method">
|
114
|
+
|
115
|
+
- (<tt>String</tt>) <strong>nav_breadcrumbs_class</strong>
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
</h3><div class="docstring">
|
122
|
+
<div class="discussion">
|
123
|
+
<p>Returns the value of the the extension option
|
124
|
+
<code>options[:nav_breadcrumbs_class]</code>.</p>
|
125
|
+
|
126
|
+
<p>Both the built-in helpers and the partials (if you
|
127
|
+
install them) use these helpers in order to access the
|
128
|
+
configuration values. When writing your own partials
|
129
|
+
it is generally unnecessary to use these helpers; you
|
130
|
+
can simply assign your own class name.</p>
|
131
|
+
|
132
|
+
<p>The provided helpers and partials use CSS classes, and
|
133
|
+
if the class names collide with your own class names
|
134
|
+
or fail to meet with your naming standards, then they
|
135
|
+
can be changed using the extension options.</p>
|
136
|
+
|
137
|
+
|
138
|
+
</div>
|
139
|
+
</div>
|
140
|
+
<div class="tags">
|
141
|
+
|
142
|
+
<p class="tag_title">Returns:</p>
|
143
|
+
<ul class="return">
|
144
|
+
|
145
|
+
<li>
|
146
|
+
|
147
|
+
|
148
|
+
<span class='type'>(<tt>String</tt>)</span>
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
—
|
153
|
+
<div class='inline'><p>Returns the name of the class.</p>
|
154
|
+
</div>
|
155
|
+
|
156
|
+
</li>
|
157
|
+
|
158
|
+
</ul>
|
159
|
+
|
160
|
+
</div>
|
161
|
+
</div>
|
162
|
+
|
163
|
+
<div class="method_details ">
|
164
|
+
<h3 class="signature " id="nav_brethren_class-instance_method">
|
165
|
+
|
166
|
+
- (<tt>String</tt>) <strong>nav_brethren_class</strong>
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
</h3><div class="docstring">
|
173
|
+
<div class="discussion">
|
174
|
+
<p>Returns the value of the the extension option
|
175
|
+
<code>options[:nav_brethren_class]</code>.</p>
|
176
|
+
|
177
|
+
<p>Both the built-in helpers and the partials (if you
|
178
|
+
install them) use these helpers in order to access the
|
179
|
+
configuration values. When writing your own partials
|
180
|
+
it is generally unnecessary to use these helpers; you
|
181
|
+
can simply assign your own class name.</p>
|
182
|
+
|
183
|
+
<p>The provided helpers and partials use CSS classes, and
|
184
|
+
if the class names collide with your own class names
|
185
|
+
or fail to meet with your naming standards, then they
|
186
|
+
can be changed using the extension options.</p>
|
187
|
+
|
188
|
+
|
189
|
+
</div>
|
190
|
+
</div>
|
191
|
+
<div class="tags">
|
192
|
+
|
193
|
+
<p class="tag_title">Returns:</p>
|
194
|
+
<ul class="return">
|
195
|
+
|
196
|
+
<li>
|
197
|
+
|
198
|
+
|
199
|
+
<span class='type'>(<tt>String</tt>)</span>
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
—
|
204
|
+
<div class='inline'><p>Returns the name of the class.</p>
|
205
|
+
</div>
|
206
|
+
|
207
|
+
</li>
|
208
|
+
|
209
|
+
</ul>
|
210
|
+
|
211
|
+
</div>
|
212
|
+
</div>
|
213
|
+
|
214
|
+
<div class="method_details ">
|
215
|
+
<h3 class="signature " id="nav_brethren_index_class-instance_method">
|
216
|
+
|
217
|
+
- (<tt>String</tt>) <strong>nav_brethren_index_class</strong>
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
</h3><div class="docstring">
|
224
|
+
<div class="discussion">
|
225
|
+
<p>Returns the value of the the extension option
|
226
|
+
<code>options[:nav_brethren_index_class]</code>.</p>
|
227
|
+
|
228
|
+
<p>Both the built-in helpers and the partials (if you
|
229
|
+
install them) use these helpers in order to access the
|
230
|
+
configuration values. When writing your own partials
|
231
|
+
it is generally unnecessary to use these helpers; you
|
232
|
+
can simply assign your own class name.</p>
|
233
|
+
|
234
|
+
<p>The provided helpers and partials use CSS classes, and
|
235
|
+
if the class names collide with your own class names
|
236
|
+
or fail to meet with your naming standards, then they
|
237
|
+
can be changed using the extension options.</p>
|
238
|
+
|
239
|
+
|
240
|
+
</div>
|
241
|
+
</div>
|
242
|
+
<div class="tags">
|
243
|
+
|
244
|
+
<p class="tag_title">Returns:</p>
|
245
|
+
<ul class="return">
|
246
|
+
|
247
|
+
<li>
|
248
|
+
|
249
|
+
|
250
|
+
<span class='type'>(<tt>String</tt>)</span>
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
—
|
255
|
+
<div class='inline'><p>Returns the name of the class.</p>
|
256
|
+
</div>
|
257
|
+
|
258
|
+
</li>
|
259
|
+
|
260
|
+
</ul>
|
261
|
+
|
262
|
+
</div>
|
263
|
+
</div>
|
264
|
+
|
265
|
+
<div class="method_details ">
|
266
|
+
<h3 class="signature " id="nav_legitimate_children_class-instance_method">
|
267
|
+
|
268
|
+
- (<tt>String</tt>) <strong>nav_legitimate_children_class</strong>
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
</h3><div class="docstring">
|
275
|
+
<div class="discussion">
|
276
|
+
<p>Returns the value of the the extension option
|
277
|
+
<code>options[:nav_legitimate_children_class]</code>.</p>
|
278
|
+
|
279
|
+
<p>Both the built-in helpers and the partials (if you
|
280
|
+
install them) use these helpers in order to access the
|
281
|
+
configuration values. When writing your own partials
|
282
|
+
it is generally unnecessary to use these helpers; you
|
283
|
+
can simply assign your own class name.</p>
|
284
|
+
|
285
|
+
<p>The provided helpers and partials use CSS classes, and
|
286
|
+
if the class names collide with your own class names
|
287
|
+
or fail to meet with your naming standards, then they
|
288
|
+
can be changed using the extension options.</p>
|
289
|
+
|
290
|
+
|
291
|
+
</div>
|
292
|
+
</div>
|
293
|
+
<div class="tags">
|
294
|
+
|
295
|
+
<p class="tag_title">Returns:</p>
|
296
|
+
<ul class="return">
|
297
|
+
|
298
|
+
<li>
|
299
|
+
|
300
|
+
|
301
|
+
<span class='type'>(<tt>String</tt>)</span>
|
302
|
+
|
303
|
+
|
304
|
+
|
305
|
+
—
|
306
|
+
<div class='inline'><p>Returns the name of the class.</p>
|
307
|
+
</div>
|
308
|
+
|
309
|
+
</li>
|
310
|
+
|
311
|
+
</ul>
|
312
|
+
|
313
|
+
</div>
|
314
|
+
</div>
|
315
|
+
|
316
|
+
<div class="method_details ">
|
317
|
+
<h3 class="signature " id="nav_prev_next_class-instance_method">
|
318
|
+
|
319
|
+
- (<tt>String</tt>) <strong>nav_prev_next_class</strong>
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
</h3><div class="docstring">
|
326
|
+
<div class="discussion">
|
327
|
+
<p>Returns the value of the the extension option
|
328
|
+
<code>options[:nav_prev_next_class]</code>.</p>
|
329
|
+
|
330
|
+
<p>Both the built-in helpers and the partials (if you
|
331
|
+
install them) use these helpers in order to access the
|
332
|
+
configuration values. When writing your own partials
|
333
|
+
it is generally unnecessary to use these helpers; you
|
334
|
+
can simply assign your own class name.</p>
|
335
|
+
|
336
|
+
<p>The provided helpers and partials use CSS classes, and
|
337
|
+
if the class names collide with your own class names
|
338
|
+
or fail to meet with your naming standards, then they
|
339
|
+
can be changed using the extension options.</p>
|
340
|
+
|
341
|
+
|
342
|
+
</div>
|
343
|
+
</div>
|
344
|
+
<div class="tags">
|
345
|
+
|
346
|
+
<p class="tag_title">Returns:</p>
|
347
|
+
<ul class="return">
|
348
|
+
|
349
|
+
<li>
|
350
|
+
|
351
|
+
|
352
|
+
<span class='type'>(<tt>String</tt>)</span>
|
353
|
+
|
354
|
+
|
355
|
+
|
356
|
+
—
|
357
|
+
<div class='inline'><p>Returns the name of the class.</p>
|
358
|
+
</div>
|
359
|
+
|
360
|
+
</li>
|
361
|
+
|
362
|
+
</ul>
|
363
|
+
|
364
|
+
</div>
|
365
|
+
</div>
|
366
|
+
|
367
|
+
<div class="method_details ">
|
368
|
+
<h3 class="signature " id="nav_prev_next_label_next-instance_method">
|
369
|
+
|
370
|
+
- (<tt>String</tt>) <strong>nav_prev_next_label_next</strong>
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
</h3><div class="docstring">
|
377
|
+
<div class="discussion">
|
378
|
+
<p>Returns the value of the the extension option
|
379
|
+
<code>options[:nav_prev_next_label_next]</code>.</p>
|
380
|
+
|
381
|
+
<p>Both the built-in helpers and the partials (if you
|
382
|
+
install them) use these helpers in order to access the
|
383
|
+
configuration values. When writing your own partials
|
384
|
+
it is generally unnecessary to use these helpers; you
|
385
|
+
can simply assign your own class name.</p>
|
386
|
+
|
387
|
+
<p>The provided helpers and partials use CSS classes, and
|
388
|
+
if the class names collide with your own class names
|
389
|
+
or fail to meet with your naming standards, then they
|
390
|
+
can be changed using the extension options.</p>
|
391
|
+
|
392
|
+
|
393
|
+
</div>
|
394
|
+
</div>
|
395
|
+
<div class="tags">
|
396
|
+
|
397
|
+
<p class="tag_title">Returns:</p>
|
398
|
+
<ul class="return">
|
399
|
+
|
400
|
+
<li>
|
401
|
+
|
402
|
+
|
403
|
+
<span class='type'>(<tt>String</tt>)</span>
|
404
|
+
|
405
|
+
|
406
|
+
|
407
|
+
—
|
408
|
+
<div class='inline'><p>Returns the name of the class.</p>
|
409
|
+
</div>
|
410
|
+
|
411
|
+
</li>
|
412
|
+
|
413
|
+
</ul>
|
414
|
+
|
415
|
+
</div>
|
416
|
+
</div>
|
417
|
+
|
418
|
+
<div class="method_details ">
|
419
|
+
<h3 class="signature " id="nav_prev_next_label_prev-instance_method">
|
420
|
+
|
421
|
+
- (<tt>String</tt>) <strong>nav_prev_next_label_prev</strong>
|
422
|
+
|
423
|
+
|
424
|
+
|
425
|
+
|
426
|
+
|
427
|
+
</h3><div class="docstring">
|
428
|
+
<div class="discussion">
|
429
|
+
<p>Returns the value of the the extension option
|
430
|
+
<code>options[:nav_prev_next_label_prev]</code>.</p>
|
431
|
+
|
432
|
+
<p>Both the built-in helpers and the partials (if you
|
433
|
+
install them) use these helpers in order to access the
|
434
|
+
configuration values. When writing your own partials
|
435
|
+
it is generally unnecessary to use these helpers; you
|
436
|
+
can simply assign your own class name.</p>
|
437
|
+
|
438
|
+
<p>The provided helpers and partials use CSS classes, and
|
439
|
+
if the class names collide with your own class names
|
440
|
+
or fail to meet with your naming standards, then they
|
441
|
+
can be changed using the extension options.</p>
|
442
|
+
|
443
|
+
|
444
|
+
</div>
|
445
|
+
</div>
|
446
|
+
<div class="tags">
|
447
|
+
|
448
|
+
<p class="tag_title">Returns:</p>
|
449
|
+
<ul class="return">
|
450
|
+
|
451
|
+
<li>
|
452
|
+
|
453
|
+
|
454
|
+
<span class='type'>(<tt>String</tt>)</span>
|
455
|
+
|
456
|
+
|
457
|
+
|
458
|
+
—
|
459
|
+
<div class='inline'><p>Returns the name of the class.</p>
|
460
|
+
</div>
|
461
|
+
|
462
|
+
</li>
|
463
|
+
|
464
|
+
</ul>
|
465
|
+
|
466
|
+
</div>
|
467
|
+
</div>
|
468
|
+
|
469
|
+
<div class="method_details ">
|
470
|
+
<h3 class="signature " id="nav_toc_index_class-instance_method">
|
471
|
+
|
472
|
+
- (<tt>String</tt>) <strong>nav_toc_index_class</strong>
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
|
477
|
+
|
478
|
+
</h3><div class="docstring">
|
479
|
+
<div class="discussion">
|
480
|
+
<p>Returns the value of the the extension option
|
481
|
+
<code>options[:nav_toc_index_class]</code>.</p>
|
482
|
+
|
483
|
+
<p>Both the built-in helpers and the partials (if you
|
484
|
+
install them) use these helpers in order to access the
|
485
|
+
configuration values. When writing your own partials
|
486
|
+
it is generally unnecessary to use these helpers; you
|
487
|
+
can simply assign your own class name.</p>
|
488
|
+
|
489
|
+
<p>The provided helpers and partials use CSS classes, and
|
490
|
+
if the class names collide with your own class names
|
491
|
+
or fail to meet with your naming standards, then they
|
492
|
+
can be changed using the extension options.</p>
|
493
|
+
|
494
|
+
|
495
|
+
</div>
|
496
|
+
</div>
|
497
|
+
<div class="tags">
|
498
|
+
|
499
|
+
<p class="tag_title">Returns:</p>
|
500
|
+
<ul class="return">
|
501
|
+
|
502
|
+
<li>
|
503
|
+
|
504
|
+
|
505
|
+
<span class='type'>(<tt>String</tt>)</span>
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
—
|
510
|
+
<div class='inline'><p>Returns the name of the class.</p>
|
511
|
+
</div>
|
512
|
+
|
513
|
+
</li>
|
514
|
+
|
515
|
+
</ul>
|
516
|
+
|
517
|
+
</div>
|
518
|
+
</div>
|
519
|
+
|
520
|
+
|
521
|
+
</div>
|
522
|
+
|
523
|
+
|