starkfish 0.2.0

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.
Files changed (34) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +26 -0
  3. data/lib/rdoc/discover.rb +30 -0
  4. data/lib/rdoc/generator/starkfish.rb +523 -0
  5. data/lib/rdoc/generator/template/starkfish/classpage.rhtml +305 -0
  6. data/lib/rdoc/generator/template/starkfish/filepage.rhtml +113 -0
  7. data/lib/rdoc/generator/template/starkfish/images/brick.png +0 -0
  8. data/lib/rdoc/generator/template/starkfish/images/brick_link.png +0 -0
  9. data/lib/rdoc/generator/template/starkfish/images/bug.png +0 -0
  10. data/lib/rdoc/generator/template/starkfish/images/bullet_black.png +0 -0
  11. data/lib/rdoc/generator/template/starkfish/images/bullet_toggle_minus.png +0 -0
  12. data/lib/rdoc/generator/template/starkfish/images/bullet_toggle_plus.png +0 -0
  13. data/lib/rdoc/generator/template/starkfish/images/date.png +0 -0
  14. data/lib/rdoc/generator/template/starkfish/images/find.png +0 -0
  15. data/lib/rdoc/generator/template/starkfish/images/loadingAnimation.gif +0 -0
  16. data/lib/rdoc/generator/template/starkfish/images/macFFBgHack.png +0 -0
  17. data/lib/rdoc/generator/template/starkfish/images/package.png +0 -0
  18. data/lib/rdoc/generator/template/starkfish/images/page_green.png +0 -0
  19. data/lib/rdoc/generator/template/starkfish/images/page_white_text.png +0 -0
  20. data/lib/rdoc/generator/template/starkfish/images/page_white_width.png +0 -0
  21. data/lib/rdoc/generator/template/starkfish/images/plugin.png +0 -0
  22. data/lib/rdoc/generator/template/starkfish/images/ruby.png +0 -0
  23. data/lib/rdoc/generator/template/starkfish/images/tag_green.png +0 -0
  24. data/lib/rdoc/generator/template/starkfish/images/wrench.png +0 -0
  25. data/lib/rdoc/generator/template/starkfish/images/wrench_orange.png +0 -0
  26. data/lib/rdoc/generator/template/starkfish/images/zoom.png +0 -0
  27. data/lib/rdoc/generator/template/starkfish/index.rhtml +57 -0
  28. data/lib/rdoc/generator/template/starkfish/js/darkfish.js +116 -0
  29. data/lib/rdoc/generator/template/starkfish/js/jquery.js +32 -0
  30. data/lib/rdoc/generator/template/starkfish/js/quicksearch.js +114 -0
  31. data/lib/rdoc/generator/template/starkfish/js/thickbox-compressed.js +10 -0
  32. data/lib/rdoc/generator/template/starkfish/rdoc.css +597 -0
  33. data/lib/rdoc/generator/template/starkfish.rhtml +3 -0
  34. metadata +90 -0
@@ -0,0 +1,597 @@
1
+ /*
2
+ * "Starkfish" Rdoc CSS
3
+ * Author: Joe E. McIlvain <github.com/jemc>
4
+ *
5
+ * A modification of "Darkfish" Rdoc CSS
6
+ * Author: Michael Granger <ged@FaerieMUD.org>
7
+ *
8
+ */
9
+
10
+
11
+ * { padding: 0; margin: 0; }
12
+
13
+ body {
14
+ background: #0A0A11;
15
+ font: 14px "Helvetica Neue", Helvetica, Tahoma, sans-serif;
16
+ margin-left: 40px;
17
+ margin-right:60px;
18
+ }
19
+ body.file-popup {
20
+ font-size: 90%;
21
+ margin-left: 0;
22
+ }
23
+
24
+ h1 {
25
+ font-size: 300%;
26
+ /*text-shadow: rgba(135,145,135,0.65) 2px 2px 3px;*/
27
+ color: #ac8;
28
+ }
29
+ h2,h3,h4 { margin-top: 1.5em; }
30
+
31
+ h1 span,
32
+ h2 span,
33
+ h3 span,
34
+ h4 span,
35
+ h5 span,
36
+ h6 span {
37
+ display: none;
38
+ padding-left: 1em;
39
+ font-size: 50%;
40
+ vertical-align: super;
41
+ }
42
+
43
+ h1:hover span,
44
+ h2:hover span,
45
+ h3:hover span,
46
+ h4:hover span,
47
+ h5:hover span,
48
+ h6:hover span {
49
+ display: inline;
50
+ }
51
+
52
+ :link,
53
+ :visited {
54
+ color: #8c6;
55
+ text-decoration: none;
56
+ }
57
+ :link:hover,
58
+ :visited:hover {
59
+ border-bottom: 1px dotted #8c6;
60
+ }
61
+
62
+ pre {
63
+ background: #ddd;
64
+ padding: 0.5em 0;
65
+ }
66
+
67
+ blockquote {
68
+ background: #ddd;
69
+ margin: 1em;
70
+ padding: 0.25em;
71
+ }
72
+
73
+ blockquote > :first-child {
74
+ margin-top: 0 !important;
75
+ }
76
+
77
+ /* @group Generic Classes */
78
+
79
+ .initially-hidden {
80
+ display: none;
81
+ }
82
+
83
+ #search-field {
84
+ width: 98%;
85
+ background: #eee;
86
+ border: none;
87
+ height: 1.5em;
88
+ -webkit-border-radius: 4px;
89
+ }
90
+ #search-field:focus {
91
+ background: #112;
92
+ }
93
+ #search-field:-moz-placeholder,
94
+ #search-field::-webkit-input-placeholder {
95
+ font-weight: bold;
96
+ color: #89a;
97
+ }
98
+
99
+ .missing-docs {
100
+ font-size: 120%;
101
+ background: white url(images/wrench_orange.png) no-repeat 4px center;
102
+ color: #245;
103
+ line-height: 2em;
104
+ border: 1px solid #d00;
105
+ opacity: 1;
106
+ padding-left: 20px;
107
+ text-indent: 24px;
108
+ letter-spacing: 3px;
109
+ font-weight: bold;
110
+ -webkit-border-radius: 5px;
111
+ -moz-border-radius: 5px;
112
+ }
113
+
114
+ .target-section {
115
+ border: 2px solid #dcce90;
116
+ border-left-width: 8px;
117
+ padding: 0 1em;
118
+ background: #fff3c2;
119
+ }
120
+
121
+ /* @end */
122
+
123
+ /* @group Index Page, Standalone file pages */
124
+ .indexpage ul {
125
+ line-height: 160%;
126
+ list-style: none;
127
+ }
128
+ .indexpage ul :link,
129
+ .indexpage ul :visited {
130
+ font-size: 16px;
131
+ }
132
+
133
+ .indexpage li {
134
+ padding-left: 20px;
135
+ }
136
+
137
+ .indexpage ul > li {
138
+ background: url(images/bullet_black.png) no-repeat left 4px;
139
+ }
140
+ .indexpage li.method {
141
+ background: url(images/plugin.png) no-repeat left 4px;
142
+ }
143
+ .indexpage li.module {
144
+ background: url(images/package.png) no-repeat left 4px;
145
+ }
146
+ .indexpage li.class {
147
+ background: url(images/ruby.png) no-repeat left 4px;
148
+ }
149
+ .indexpage li.file {
150
+ background: url(images/page_white_text.png) no-repeat left 4px;
151
+ }
152
+ .indexpage li li {
153
+ background: url(images/tag_blue.png) no-repeat left 4px;
154
+ }
155
+ .indexpage li .toc-toggle {
156
+ width: 16px;
157
+ height: 16px;
158
+ background: url(images/add.png) no-repeat;
159
+ }
160
+
161
+ .indexpage li .toc-toggle.open {
162
+ background: url(images/delete.png) no-repeat;
163
+ }
164
+
165
+ /* @end */
166
+
167
+ /* @group Top-Level Structure */
168
+
169
+ #metadata {
170
+ float: left;
171
+ width: 260px;
172
+ }
173
+
174
+ #documentation {
175
+ margin: 2em 1em 5em 300px;
176
+ min-width: 340px;
177
+ }
178
+
179
+ #validator-badges {
180
+ clear: both;
181
+ margin: 1em 1em 2em;
182
+ font-size: smaller;
183
+ }
184
+
185
+ /* @end */
186
+
187
+ /* @group Metadata Section */
188
+ #metadata .section {
189
+ background-color: #134;
190
+ -moz-border-radius: 5px;
191
+ -webkit-border-radius: 5px;
192
+ border: 1px solid #d92;
193
+ margin: 0 8px 8px;
194
+ font-size: 90%;
195
+ overflow: hidden;
196
+ }
197
+ #metadata h3.section-header {
198
+ margin: 0;
199
+ padding: 2px 8px;
200
+ background: #245;
201
+ color: #9ca;
202
+ -moz-border-radius-topleft: 4px;
203
+ -moz-border-radius-topright: 4px;
204
+ -webkit-border-top-left-radius: 4px;
205
+ -webkit-border-top-right-radius: 4px;
206
+ border-bottom: 1px solid #d92;
207
+ }
208
+ #metadata #home-section h3.section-header {
209
+ border-bottom: 0;
210
+ }
211
+
212
+ #metadata ul,
213
+ #metadata dl,
214
+ #metadata p {
215
+ padding: 8px;
216
+ list-style: none;
217
+ }
218
+
219
+ #file-metadata {
220
+ margin-top: 2em;
221
+ }
222
+
223
+ #file-metadata ul {
224
+ padding-left: 28px;
225
+ list-style-image: url(images/page_green.png);
226
+ }
227
+
228
+ #table-of-contents {
229
+ margin-top: 2em;
230
+ }
231
+
232
+ #table-of-contents ul {
233
+ padding-left: 28px;
234
+ list-style-image: url(images/tag_blue.png);
235
+ }
236
+
237
+ dl.svninfo {
238
+ color: #89a;
239
+ margin: 0;
240
+ }
241
+ dl.svninfo dt {
242
+ font-weight: bold;
243
+ }
244
+
245
+ ul.link-list li {
246
+ white-space: nowrap;
247
+ line-height: 20px;
248
+ }
249
+
250
+ ul.link-list .type {
251
+ font-size: 8px;
252
+ text-transform: uppercase;
253
+ color: white;
254
+ background: #969696;
255
+ padding: 2px 4px;
256
+ -webkit-border-radius: 5px;
257
+ }
258
+
259
+ .calls-super {
260
+ background: url(images/arrow_up.png) no-repeat right center;
261
+ }
262
+
263
+ /* @end */
264
+
265
+ /* @group Class Metadata Section */
266
+ #class-metadata {
267
+ margin-top: 2em;
268
+ }
269
+ /* @end */
270
+
271
+ /* @group Project Metadata Section */
272
+ #project-metadata {
273
+ margin-top: 2em;
274
+ }
275
+
276
+ #project-metadata .section {
277
+ border: 1px solid #d92;
278
+ }
279
+ #project-metadata h3.section-header {
280
+ border-bottom: 1px solid #d92;
281
+ position: relative;
282
+ }
283
+
284
+ #project-metadata form {
285
+ color: #777;
286
+ background: #245;
287
+ }
288
+
289
+ /* @end */
290
+
291
+ /* @group Documentation Section */
292
+ .description {
293
+ font-size: 100%;
294
+ color: #9ca;
295
+ }
296
+
297
+ .description p {
298
+ margin: 1em 0.4em;
299
+ }
300
+
301
+ .description li p {
302
+ margin: 0;
303
+ }
304
+
305
+ .description ol,
306
+ .description ul {
307
+ margin-left: 1.5em;
308
+ }
309
+ .description ol li,
310
+ .description ul li {
311
+ line-height: 1.4em;
312
+ }
313
+
314
+ .note-list {
315
+ margin: 8px 0;
316
+ }
317
+
318
+ .label-list {
319
+ margin: 8px 1.5em;
320
+ border: 1px solid #245;
321
+ }
322
+ .description .label-list {
323
+ font-size: 14px;
324
+ }
325
+
326
+ .note-list dt {
327
+ font-weight: bold;
328
+ }
329
+ .note-list dd {
330
+ padding: 0 12px;
331
+ }
332
+
333
+ .label-list dt {
334
+ padding: 2px 4px;
335
+ font-weight: bold;
336
+ color: #AE81FF;
337
+ background: #000;
338
+ }
339
+ .label-list dd {
340
+ padding: 2px 12px;
341
+ }
342
+ .label-list dd + dt,
343
+ .note-list dd + dt {
344
+ margin-top: 0.7em;
345
+ }
346
+
347
+ #documentation .section {
348
+ font-size: 90%;
349
+ }
350
+
351
+ #documentation h2.section-header {
352
+ margin-top: 1em;
353
+ padding: 0.25em 0.5em;
354
+ background: #245;
355
+ color: #9ca;
356
+ font-size: 175%;
357
+ border: 1px solid #bbb;
358
+ -moz-border-radius: 3px;
359
+ -webkit-border-radius: 3px;
360
+ }
361
+
362
+ .documentation-section-title {
363
+ position: relative;
364
+ }
365
+ .documentation-section-title .section-click-top {
366
+ position: absolute;
367
+ top: 6px;
368
+ right: 12px;
369
+ font-size: 10px;
370
+ color: #9b9877;
371
+ visibility: hidden;
372
+ padding-right: 0.5px;
373
+ }
374
+
375
+ .documentation-section-title:hover .section-click-top {
376
+ visibility: visible;
377
+ }
378
+
379
+ #documentation h3.section-header {
380
+ margin-top: 1em;
381
+ padding: 0.25em 0.5em;
382
+ background-color: #134;
383
+ color: #9ca;
384
+ font-size: 150%;
385
+ border: 1px solid #bbb;
386
+ -moz-border-radius: 3px;
387
+ -webkit-border-radius: 3px;
388
+ }
389
+
390
+ #constants-list > dl,
391
+ #attributes-list > dl {
392
+ margin: 1em 0 2em;
393
+ border: 0;
394
+ }
395
+ #constants-list > dl dt,
396
+ #attributes-list > dl dt {
397
+ padding-left: 0;
398
+ font-weight: bold;
399
+ font-family: Monaco, "Andale Mono";
400
+ background: inherit;
401
+ }
402
+ #constants-list > dl dt a,
403
+ #attributes-list > dl dt a {
404
+ color: inherit;
405
+ }
406
+ #constants-list > dl dd,
407
+ #attributes-list > dl dd {
408
+ margin: 0 0 1em 0;
409
+ padding: 0;
410
+ color: #89a;
411
+ }
412
+
413
+ .documentation-section h2 {
414
+ position: relative;
415
+ }
416
+
417
+ .documentation-section h2 a {
418
+ position: absolute;
419
+ top: 8px;
420
+ right: 10px;
421
+ font-size: 12px;
422
+ color: #9b9877;
423
+ visibility: hidden;
424
+ }
425
+
426
+ .documentation-section h2:hover a {
427
+ visibility: visible;
428
+ }
429
+
430
+ /* @group Method Details */
431
+
432
+ #documentation .method-source-code {
433
+ display: none;
434
+ }
435
+
436
+ #documentation .method-description .method-calls-super {
437
+ color: #9ca;
438
+ font-weight: bolder;
439
+ }
440
+
441
+ #documentation .method-detail {
442
+ margin: 0.5em 0;
443
+ padding: 0.5em 0;
444
+ cursor: pointer;
445
+ }
446
+ #documentation .method-detail:hover {
447
+ background-color: #112;
448
+ }
449
+ #documentation .method-heading {
450
+ position: relative;
451
+ padding: 2px 4px 0 20px;
452
+ font-size: 125%;
453
+ font-weight: bold;
454
+ color: #9ca;
455
+ background: url(images/brick.png) no-repeat left bottom;
456
+ }
457
+ #documentation .method-heading :link,
458
+ #documentation .method-heading :visited {
459
+ color: inherit;
460
+ }
461
+ #documentation .method-click-advice {
462
+ position: absolute;
463
+ top: 2px;
464
+ right: 5px;
465
+ font-size: 10px;
466
+ color: #9b9877;
467
+ visibility: hidden;
468
+ padding-right: 20px;
469
+ line-height: 20px;
470
+ background: url(images/zoom.png) no-repeat right top;
471
+ }
472
+ #documentation .method-heading:hover .method-click-advice {
473
+ visibility: visible;
474
+ }
475
+
476
+ #documentation .method-alias .method-heading {
477
+ color: #89a;
478
+ background: url(images/brick_link.png) no-repeat left bottom;
479
+ }
480
+
481
+ #documentation .method-description,
482
+ #documentation .aliases {
483
+ margin: 0 20px;
484
+ color: #89a;
485
+ }
486
+
487
+ #documentation .method-description p,
488
+ #documentation .aliases p {
489
+ line-height: 1.2em;
490
+ }
491
+
492
+ #documentation .aliases {
493
+ padding-top: 4px;
494
+ font-style: italic;
495
+ cursor: default;
496
+ }
497
+ #documentation .method-description p {
498
+ margin-bottom: 0.5em;
499
+ }
500
+ #documentation .method-description ul {
501
+ margin-left: 1.5em;
502
+ }
503
+ pre {
504
+ margin: 0.5em 0;
505
+ }
506
+
507
+ #documentation .attribute-method-heading {
508
+ background: url(images/tag_green.png) no-repeat left bottom;
509
+ }
510
+ #documentation #attribute-method-details .method-detail:hover {
511
+ background-color: transparent;
512
+ cursor: default;
513
+ }
514
+ #documentation .attribute-access-type {
515
+ font-size: 60%;
516
+ text-transform: uppercase;
517
+ vertical-align: super;
518
+ padding: 0 2px;
519
+ }
520
+ /* @end */
521
+
522
+ /* @end */
523
+
524
+ /* @group Source Code */
525
+
526
+ pre {
527
+ overflow: auto;
528
+ background: #060611;
529
+ color: #901025;
530
+ border: 1px dashed #999;
531
+ padding: 0.5em;
532
+ }
533
+
534
+ .description pre {
535
+ margin: 0 0.4em;
536
+ }
537
+
538
+ .ruby-constant { color: #7fffd4; background: transparent; }
539
+ .ruby-keyword { color: #C89112; background: transparent; }
540
+ .ruby-ivar { color: #61A1B2; background: transparent; }
541
+ .ruby-operator { color: #D83B21; background: transparent; }
542
+ .ruby-identifier { color: #537D94; background: transparent; }
543
+ .ruby-node { color: #62C324; background: transparent; }
544
+ .ruby-string { color: #62C324; background: transparent; }
545
+ .ruby-comment { color: #2B2B49; font-weight: bold; background: transparent; }
546
+ .ruby-regexp { color: #62C324; background: transparent; }
547
+ .ruby-value { color: #AE81FF; background: transparent; }
548
+
549
+ /* @end */
550
+
551
+
552
+ /* @group search results */
553
+ #search-results h1 {
554
+ font-size: 1em;
555
+ font-weight: normal;
556
+ text-shadow: none;
557
+ }
558
+
559
+ #search-results .current {
560
+ background: #245;
561
+ border-bottom: 1px solid transparent;
562
+ }
563
+
564
+ #search-results li {
565
+ list-style: none;
566
+ border-bottom: 1px solid #d92;
567
+ -moz-border-radius: 4px;
568
+ -webkit-border-radius: 4px;
569
+ border-radius: 4px;
570
+ margin-bottom: 0.5em;
571
+ }
572
+
573
+ #search-results li:last-child {
574
+ border-bottom: none;
575
+ margin-bottom: 0;
576
+ }
577
+
578
+ #search-results li p {
579
+ padding: 0;
580
+ margin: 0.5em;
581
+ }
582
+
583
+ #search-results .search-namespace {
584
+ font-weight: bold;
585
+ }
586
+
587
+ #search-results li em {
588
+ background: yellow;
589
+ font-style: normal;
590
+ }
591
+
592
+ #search-results pre {
593
+ margin: 0.5em;
594
+ }
595
+
596
+ /* @end */
597
+
@@ -0,0 +1,3 @@
1
+ <!-- before -->
2
+ <%= content %>
3
+ <!-- after -->
metadata ADDED
@@ -0,0 +1,90 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: starkfish
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.2.0
5
+ platform: ruby
6
+ authors:
7
+ - Joe McIlvain
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2013-07-20 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rdoc
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: '4.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: '4.0'
27
+ description: An aesthetically revised template for darkfish,the rdoc documentation
28
+ generator for ruby.
29
+ email: joe.eli.mac@gmail.com
30
+ executables: []
31
+ extensions: []
32
+ extra_rdoc_files: []
33
+ files:
34
+ - lib/rdoc/generator/starkfish.rb
35
+ - lib/rdoc/generator/template/starkfish/js/jquery.js
36
+ - lib/rdoc/generator/template/starkfish/js/quicksearch.js
37
+ - lib/rdoc/generator/template/starkfish/js/thickbox-compressed.js
38
+ - lib/rdoc/generator/template/starkfish/js/darkfish.js
39
+ - lib/rdoc/generator/template/starkfish/classpage.rhtml
40
+ - lib/rdoc/generator/template/starkfish/rdoc.css
41
+ - lib/rdoc/generator/template/starkfish/filepage.rhtml
42
+ - lib/rdoc/generator/template/starkfish/images/bullet_toggle_plus.png
43
+ - lib/rdoc/generator/template/starkfish/images/page_white_text.png
44
+ - lib/rdoc/generator/template/starkfish/images/zoom.png
45
+ - lib/rdoc/generator/template/starkfish/images/wrench_orange.png
46
+ - lib/rdoc/generator/template/starkfish/images/ruby.png
47
+ - lib/rdoc/generator/template/starkfish/images/find.png
48
+ - lib/rdoc/generator/template/starkfish/images/bullet_black.png
49
+ - lib/rdoc/generator/template/starkfish/images/brick_link.png
50
+ - lib/rdoc/generator/template/starkfish/images/page_green.png
51
+ - lib/rdoc/generator/template/starkfish/images/bug.png
52
+ - lib/rdoc/generator/template/starkfish/images/page_white_width.png
53
+ - lib/rdoc/generator/template/starkfish/images/loadingAnimation.gif
54
+ - lib/rdoc/generator/template/starkfish/images/package.png
55
+ - lib/rdoc/generator/template/starkfish/images/brick.png
56
+ - lib/rdoc/generator/template/starkfish/images/wrench.png
57
+ - lib/rdoc/generator/template/starkfish/images/bullet_toggle_minus.png
58
+ - lib/rdoc/generator/template/starkfish/images/tag_green.png
59
+ - lib/rdoc/generator/template/starkfish/images/macFFBgHack.png
60
+ - lib/rdoc/generator/template/starkfish/images/date.png
61
+ - lib/rdoc/generator/template/starkfish/images/plugin.png
62
+ - lib/rdoc/generator/template/starkfish/index.rhtml
63
+ - lib/rdoc/generator/template/starkfish.rhtml
64
+ - lib/rdoc/discover.rb
65
+ - LICENSE
66
+ homepage: https://github.com/jemc/starkfish/
67
+ licenses:
68
+ - 'Copyright (c) Joe McIlvain. All rights reserved '
69
+ metadata: {}
70
+ post_install_message:
71
+ rdoc_options: []
72
+ require_paths:
73
+ - lib
74
+ required_ruby_version: !ruby/object:Gem::Requirement
75
+ requirements:
76
+ - - '>='
77
+ - !ruby/object:Gem::Version
78
+ version: '0'
79
+ required_rubygems_version: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - '>='
82
+ - !ruby/object:Gem::Version
83
+ version: '0'
84
+ requirements: []
85
+ rubyforge_project:
86
+ rubygems_version: 2.0.2
87
+ signing_key:
88
+ specification_version: 4
89
+ summary: starkfish
90
+ test_files: []