jazzy 0.0.14 → 0.0.15

Sign up to get free protection for your applications and to get access to all the features.
Files changed (44) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +6 -4
  3. data/README.md +2 -2
  4. data/jazzy.gemspec +1 -0
  5. data/lib/jazzy/assets/css/github_syntax_highlighting.css.scss +142 -0
  6. data/lib/jazzy/assets/css/jazzy.css.scss +321 -0
  7. data/lib/jazzy/config.rb +1 -0
  8. data/lib/jazzy/doc.mustache +1 -0
  9. data/lib/jazzy/doc_builder.rb +30 -22
  10. data/lib/jazzy/gem_version.rb +1 -1
  11. data/lib/jazzy/jazzy_markdown.rb +27 -1
  12. data/lib/jazzy/partials/task.mustache +7 -0
  13. data/lib/jazzy/readme_generator.rb +35 -0
  14. data/lib/jazzy/source_declaration.rb +1 -0
  15. data/lib/jazzy/source_mark.rb +31 -0
  16. data/lib/jazzy/sourcekitten.rb +7 -0
  17. data/logo.jpg +0 -0
  18. data/spec/integration_specs/document_alamofire/after/docs/Classes.html +15 -4
  19. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html +14 -4
  20. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/init(configuration:).html +4 -4
  21. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html +40 -4
  22. data/spec/integration_specs/document_alamofire/after/docs/Enums.html +5 -4
  23. data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html +4 -4
  24. data/spec/integration_specs/document_alamofire/after/docs/Extensions.html +112 -4
  25. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Manager.html +18 -3
  26. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request.html +4 -4
  27. data/spec/integration_specs/document_alamofire/after/docs/Functions.html +66 -3
  28. data/spec/integration_specs/document_alamofire/after/docs/Global Variables.html +4 -4
  29. data/spec/integration_specs/document_alamofire/after/docs/Protocols.html +20 -3
  30. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html +4 -4
  31. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLStringConvertible.html +4 -4
  32. data/spec/integration_specs/document_alamofire/after/docs/css/github_syntax_highlighting.css +98 -0
  33. data/spec/integration_specs/document_alamofire/after/docs/css/jazzy.css +250 -0
  34. data/spec/integration_specs/document_alamofire/after/docs/index.html +572 -1
  35. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes.html +7 -3
  36. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +4 -4
  37. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums.html +7 -3
  38. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +4 -4
  39. data/spec/integration_specs/misc_jazzy_features/after/docs/Global Variables.html +6 -3
  40. data/spec/integration_specs/misc_jazzy_features/after/docs/css/github_syntax_highlighting.css +98 -0
  41. data/spec/integration_specs/misc_jazzy_features/after/docs/css/jazzy.css +250 -0
  42. data/spec/integration_specs/misc_jazzy_features/after/docs/index.html +4 -1
  43. data/spec/integration_specs/misc_jazzy_features/before/docs/css/jazzy.css +48 -0
  44. metadata +22 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 6e5a10f6a6e2ae160d56aacfb558c9494dbcb63c
4
- data.tar.gz: b1476b977cc1e71e2b508263b5c750f368ed34fb
3
+ metadata.gz: 7cb0dbb4a6f3cd950cce91c753acf09742ae0912
4
+ data.tar.gz: be7cdc331cb23ad0fe1d8bc16f8f37c4fc61ea50
5
5
  SHA512:
6
- metadata.gz: ae051cb030b903b460907f8cc5dd041f7c6bae179ff3cc8f7ec14271d0c44cfb80b7e99734c866f2d138d6cb0907fe59c8ee6e12251245b960ead1a5089b9f73
7
- data.tar.gz: 370f5f57284c90032514209c47c2191b85ccd890d86ace267669bea4a559c23921985a6a20cd0b259dcc484e0d22d82075720037dd5c9b2e01bfac99d6bb7413
6
+ metadata.gz: 511a552ddd739da369ce55affe2b4bac8afe8fc21b0e83c9fee2e928ed2f22b64245a60691c93ffbb5f016d240dac18a9b7b2433df2ec3d50807ad893f33c568
7
+ data.tar.gz: f7ab8a26bc341ea31cb5d0e4d17f32c5e34eada4f699feb2bfa0a2c09b84e64a45ca5636ab4ac806fcce82e22fc4fd61f3ef87207837dd298031dc88f6ebe852
@@ -1,17 +1,18 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- jazzy (0.0.14)
4
+ jazzy (0.0.15)
5
5
  activesupport (~> 4.1)
6
6
  mustache (~> 0.99)
7
7
  nokogiri (~> 1.6)
8
8
  redcarpet (~> 3.2)
9
+ rouge (~> 1.5)
9
10
  sass (~> 3.4)
10
11
 
11
12
  GEM
12
13
  remote: http://rubygems.org/
13
14
  specs:
14
- activesupport (4.1.7)
15
+ activesupport (4.1.8)
15
16
  i18n (~> 0.6, >= 0.6.9)
16
17
  json (~> 1.7, >= 1.7.7)
17
18
  minitest (~> 5.1)
@@ -33,7 +34,7 @@ GEM
33
34
  json (1.8.1)
34
35
  metaclass (0.0.4)
35
36
  mini_portile (0.6.1)
36
- minitest (5.4.2)
37
+ minitest (5.4.3)
37
38
  mocha (1.1.0)
38
39
  metaclass (~> 0.0.1)
39
40
  mocha-on-bacon (0.2.2)
@@ -50,6 +51,7 @@ GEM
50
51
  rainbow (2.0.0)
51
52
  rake (10.3.2)
52
53
  redcarpet (3.2.0)
54
+ rouge (1.7.3)
53
55
  rubocop (0.26.1)
54
56
  astrolabe (~> 1.3)
55
57
  parser (>= 2.2.0.pre.4, < 3.0)
@@ -58,7 +60,7 @@ GEM
58
60
  ruby-progressbar (~> 1.4)
59
61
  ruby-progressbar (1.6.0)
60
62
  safe_yaml (1.0.4)
61
- sass (3.4.7)
63
+ sass (3.4.8)
62
64
  slop (3.6.0)
63
65
  thread_safe (0.3.4)
64
66
  tzinfo (1.2.2)
data/README.md CHANGED
@@ -1,5 +1,5 @@
1
- ## jazzy <sup>♪♫</sup>
2
- **a soulful way to generate docs for Swift & Objective-C**
1
+ ![jazzy](logo.jpg)
2
+
3
3
  ![analytics](https://ga-beacon.appspot.com/UA-50247013-2/jazzy/README?pixel)
4
4
 
5
5
  ![Test Status](https://travis-ci.org/realm/jazzy.svg?branch=master)
@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
22
22
  spec.add_runtime_dependency 'redcarpet', '~> 3.2'
23
23
  spec.add_runtime_dependency 'nokogiri', '~> 1.6'
24
24
  spec.add_runtime_dependency 'sass', '~> 3.4'
25
+ spec.add_runtime_dependency 'rouge', '~> 1.5'
25
26
 
26
27
  spec.add_development_dependency 'bundler', '~> 1.7'
27
28
  spec.add_development_dependency 'rake', '~> 10.3'
@@ -0,0 +1,142 @@
1
+ /* Credit to https://github.com/magnetikonline/ghmarkdownrender */
2
+
3
+ .highlight {
4
+ .bp {
5
+ color: #999999;
6
+ }
7
+ .c1, .cm {
8
+ color: #999988;
9
+ font-style: italic;
10
+ }
11
+ .cp {
12
+ color: #999999;
13
+ font-weight: bold;
14
+ }
15
+ .cs {
16
+ color: #999999;
17
+ font-weight: bold;
18
+ font-style: italic;
19
+ }
20
+ .c {
21
+ color: #999988;
22
+ font-style: italic;
23
+ }
24
+ .err {
25
+ color: #a61717;
26
+ background: #e3d2d2;
27
+ }
28
+ .gc {
29
+ color: #999;
30
+ background: #eaf2f5;
31
+ }
32
+ .gd {
33
+ .x {
34
+ color: #000000;
35
+ background: #ffaaaa;
36
+ }
37
+ color: #000000;
38
+ background: #ffdddd;
39
+ }
40
+ .ge {
41
+ font-style: italic;
42
+ }
43
+ .gh {
44
+ color: #999999;
45
+ }
46
+ .gi {
47
+ .x {
48
+ color: #000000;
49
+ background: #aaffaa;
50
+ }
51
+ color: #000000;
52
+ background: #ddffdd;
53
+ }
54
+ .go {
55
+ color: #888888;
56
+ }
57
+ .gp {
58
+ color: #555555;
59
+ }
60
+ .gr {
61
+ color: #aa0000;
62
+ }
63
+ .gs {
64
+ font-weight: bold;
65
+ }
66
+ .gt {
67
+ color: #aa0000;
68
+ }
69
+ .gu {
70
+ color: #800080;
71
+ font-weight: bold;
72
+ }
73
+ .il {
74
+ color: #009999;
75
+ }
76
+ .kc, .kd, .kn, .kp, .kr {
77
+ font-weight: bold;
78
+ }
79
+ .kt {
80
+ color: #445588;
81
+ font-weight: bold;
82
+ }
83
+ .k {
84
+ font-weight: bold;
85
+ }
86
+ .mf, .mh, .mi, .mo, .m {
87
+ color: #009999;
88
+ }
89
+ .na {
90
+ color: #008080;
91
+ }
92
+ .nb {
93
+ color: #0086b3;
94
+ }
95
+ .nc {
96
+ color: #445588;
97
+ font-weight: bold;
98
+ }
99
+ .ne, .nf {
100
+ color: #990000;
101
+ font-weight: bold;
102
+ }
103
+ .ni {
104
+ color: #800080;
105
+ }
106
+ .nn {
107
+ color: #555555;
108
+ }
109
+ .no {
110
+ color: #008080;
111
+ }
112
+ .nt {
113
+ color: #000080;
114
+ }
115
+ .nv {
116
+ color: #008080;
117
+ }
118
+ .n {
119
+ color: #333333;
120
+ }
121
+ .ow, .o {
122
+ font-weight: bold;
123
+ }
124
+ .s1, .s2, .sb, .sc, .sd, .se, .sh, .si {
125
+ color: #d14;
126
+ }
127
+ .sr {
128
+ color: #009926;
129
+ }
130
+ .ss {
131
+ color: #990073;
132
+ }
133
+ .sx, .s {
134
+ color: #d14;
135
+ }
136
+ .vc, .vg, .vi {
137
+ color: #008080;
138
+ }
139
+ .w {
140
+ color: #bbbbbb;
141
+ }
142
+ }
@@ -527,3 +527,324 @@ td {
527
527
  width: 734px;
528
528
  z-index: -1;
529
529
  }
530
+
531
+ .readme {
532
+ -ms-text-size-adjust: 100%;
533
+ -webkit-text-size-adjust: 100%;
534
+ color: rgba(65, 65, 65, 1);
535
+ overflow: hidden;
536
+ font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif;
537
+ font-size: 16px;
538
+ line-height: 1.6;
539
+ word-wrap: break-word;
540
+ a {
541
+ background: transparent;
542
+ &:active,
543
+ &:hover {
544
+ outline: 0;
545
+ }
546
+ }
547
+ strong {
548
+ font-weight: bold;
549
+ }
550
+ h1 {
551
+ font-size: 2em;
552
+ margin: 0.67em 0;
553
+ }
554
+ img {
555
+ border: 0;
556
+ }
557
+ hr {
558
+ -moz-box-sizing: content-box;
559
+ box-sizing: content-box;
560
+ height: 0;
561
+ }
562
+ pre {
563
+ overflow: auto;
564
+ }
565
+ code,
566
+ kbd,
567
+ pre {
568
+ font-family: monospace, monospace;
569
+ font-size: 1em;
570
+ }
571
+ table {
572
+ border-collapse: collapse;
573
+ border-spacing: 0;
574
+ }
575
+ td,
576
+ th {
577
+ padding: 0;
578
+ }
579
+ * {
580
+ -moz-box-sizing: border-box;
581
+ box-sizing: border-box;
582
+ }
583
+ a {
584
+ color: #4183c4;
585
+ text-decoration: none;
586
+ &:hover,
587
+ &:focus,
588
+ &:active {
589
+ text-decoration: underline;
590
+ }
591
+ }
592
+ hr {
593
+ height: 0;
594
+ margin: 15px 0;
595
+ overflow: hidden;
596
+ background: transparent;
597
+ border: 0;
598
+ border-bottom: 1px solid #ddd;
599
+ &:before {
600
+ display: table;
601
+ content: "";
602
+ }
603
+ &:after {
604
+ display: table;
605
+ clear: both;
606
+ content: "";
607
+ }
608
+ }
609
+ h1,
610
+ h2,
611
+ h3,
612
+ h4,
613
+ h5,
614
+ h6 {
615
+ margin-top: 15px;
616
+ margin-bottom: 15px;
617
+ line-height: 1.1;
618
+ }
619
+ h1 {
620
+ font-size: 30px;
621
+ }
622
+ h2 {
623
+ font-size: 21px;
624
+ }
625
+ h3 {
626
+ font-size: 16px;
627
+ }
628
+ h4 {
629
+ font-size: 14px;
630
+ }
631
+ h5 {
632
+ font-size: 12px;
633
+ }
634
+ h6 {
635
+ font-size: 11px;
636
+ }
637
+ blockquote {
638
+ margin: 0;
639
+ }
640
+ ul,
641
+ ol {
642
+ padding: 0;
643
+ margin-top: 0;
644
+ margin-bottom: 0;
645
+ }
646
+ ol ol,
647
+ ul ol {
648
+ list-style-type: lower-roman;
649
+ }
650
+ ul ul ol,
651
+ ul ol ol,
652
+ ol ul ol,
653
+ ol ol ol {
654
+ list-style-type: lower-alpha;
655
+ }
656
+ dd {
657
+ margin-left: 0;
658
+ }
659
+ code {
660
+ font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
661
+ }
662
+ pre {
663
+ margin-top: 0;
664
+ margin-bottom: 0;
665
+ font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
666
+ }
667
+ & > *:first-child {
668
+ margin-top: 0 !important;
669
+ }
670
+ & > *:last-child {
671
+ margin-bottom: 0 !important;
672
+ }
673
+ h1,
674
+ h2,
675
+ h3,
676
+ h4,
677
+ h5,
678
+ h6 {
679
+ position: relative;
680
+ margin-top: 1em;
681
+ margin-bottom: 16px;
682
+ font-weight: bold;
683
+ line-height: 1.4;
684
+ }
685
+ h1 {
686
+ padding-bottom: 0.3em;
687
+ font-size: 2.25em;
688
+ line-height: 1.2;
689
+ border-bottom: 1px solid #eee;
690
+ }
691
+ h2 {
692
+ padding-bottom: 0.3em;
693
+ font-size: 1.75em;
694
+ line-height: 1.225;
695
+ border-bottom: 1px solid #eee;
696
+ }
697
+ h3 {
698
+ font-size: 1.5em;
699
+ line-height: 1.43;
700
+ }
701
+ h4 {
702
+ font-size: 1.25em;
703
+ }
704
+ h5 {
705
+ font-size: 1em;
706
+ }
707
+ h6 {
708
+ font-size: 1em;
709
+ color: #777;
710
+ }
711
+ p,
712
+ blockquote,
713
+ ul,
714
+ ol,
715
+ dl,
716
+ table,
717
+ pre {
718
+ margin-top: 0;
719
+ margin-bottom: 16px;
720
+ }
721
+ hr {
722
+ height: 4px;
723
+ padding: 0;
724
+ margin: 16px 0;
725
+ background-color: #e7e7e7;
726
+ border: 0 none;
727
+ }
728
+ ul,
729
+ ol {
730
+ padding-left: 2em;
731
+ }
732
+ ul ul,
733
+ ul ol,
734
+ ol ol,
735
+ ol ul {
736
+ margin-top: 0;
737
+ margin-bottom: 0;
738
+ }
739
+ li > p {
740
+ margin-top: 16px;
741
+ }
742
+ dl {
743
+ padding: 0;
744
+ dt {
745
+ padding: 0;
746
+ margin-top: 16px;
747
+ font-size: 1em;
748
+ font-style: italic;
749
+ font-weight: bold;
750
+ }
751
+ dd {
752
+ padding: 0 16px;
753
+ margin-bottom: 16px;
754
+ }
755
+ }
756
+ blockquote {
757
+ padding: 0 15px;
758
+ color: #777;
759
+ border-left: 4px solid #ddd;
760
+ & > :first-child {
761
+ margin-top: 0;
762
+ }
763
+ & > :last-child {
764
+ margin-bottom: 0;
765
+ }
766
+ }
767
+ table {
768
+ display: block;
769
+ width: 100%;
770
+ overflow: auto;
771
+ word-break: normal;
772
+ word-break: keep-all;
773
+ th {
774
+ font-weight: bold;
775
+ }
776
+ th, td {
777
+ padding: 6px 13px;
778
+ border: 1px solid #ddd;
779
+ }
780
+ tr {
781
+ background-color: #fff;
782
+ border-top: 1px solid #ccc;
783
+ &:nth-child(2n) {
784
+ background-color: #f8f8f8;
785
+ }
786
+ }
787
+ }
788
+ img {
789
+ max-width: 100%;
790
+ -moz-box-sizing: border-box;
791
+ box-sizing: border-box;
792
+ }
793
+ code {
794
+ padding: 0;
795
+ padding-top: 0.2em;
796
+ padding-bottom: 0.2em;
797
+ margin: 0;
798
+ font-size: 85%;
799
+ background-color: rgba(0, 0, 0, 0.04);
800
+ border-radius: 3px;
801
+ &:after,
802
+ &:before {
803
+ letter-spacing: -0.2em;
804
+ content: "\00a0";
805
+ }
806
+ }
807
+ pre > code {
808
+ padding: 0;
809
+ margin: 0;
810
+ font-size: 100%;
811
+ word-break: normal;
812
+ white-space: pre;
813
+ background: transparent;
814
+ border: 0;
815
+ }
816
+ .highlight {
817
+ margin-bottom: 16px;
818
+ }
819
+ .highlight pre,
820
+ pre {
821
+ padding: 16px;
822
+ overflow: auto;
823
+ font-size: 85%;
824
+ line-height: 1.45;
825
+ background-color: #f7f7f7;
826
+ border-radius: 3px;
827
+ }
828
+ .highlight pre {
829
+ margin-bottom: 0;
830
+ word-break: normal;
831
+ }
832
+ pre {
833
+ word-wrap: normal;
834
+ code {
835
+ display: inline;
836
+ max-width: initial;
837
+ padding: 0;
838
+ margin: 0;
839
+ overflow: initial;
840
+ line-height: inherit;
841
+ word-wrap: normal;
842
+ background-color: transparent;
843
+ border: 0;
844
+ &:before,
845
+ &:after {
846
+ content: normal;
847
+ }
848
+ }
849
+ }
850
+ }