jazzy 0.13.7 → 0.14.2

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 (75) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/Tests.yml +6 -6
  3. data/.rubocop.yml +155 -24
  4. data/CHANGELOG.md +91 -0
  5. data/CONTRIBUTING.md +1 -1
  6. data/Dangerfile +11 -8
  7. data/Gemfile +3 -1
  8. data/Gemfile.lock +85 -64
  9. data/ObjectiveC.md +208 -0
  10. data/README.md +63 -33
  11. data/Rakefile +18 -15
  12. data/bin/jazzy +3 -2
  13. data/bin/sourcekitten +0 -0
  14. data/jazzy.gemspec +9 -6
  15. data/lib/jazzy/config.rb +135 -69
  16. data/lib/jazzy/doc.rb +3 -1
  17. data/lib/jazzy/doc_builder.rb +72 -83
  18. data/lib/jazzy/docset_builder.rb +3 -1
  19. data/lib/jazzy/documentation_generator.rb +6 -2
  20. data/lib/jazzy/executable.rb +3 -0
  21. data/lib/jazzy/extensions/bitbucket/img/bitbucket.svg +11 -0
  22. data/lib/jazzy/{themes/apple/assets → extensions/github}/img/gh.png +0 -0
  23. data/lib/jazzy/extensions/gitlab/img/gitlab.svg +23 -0
  24. data/lib/jazzy/gem_version.rb +3 -1
  25. data/lib/jazzy/highlighter.rb +5 -3
  26. data/lib/jazzy/jazzy_markdown.rb +75 -32
  27. data/lib/jazzy/podspec_documenter.rb +14 -16
  28. data/lib/jazzy/search_builder.rb +5 -6
  29. data/lib/jazzy/source_declaration/access_control_level.rb +7 -5
  30. data/lib/jazzy/source_declaration/type.rb +29 -3
  31. data/lib/jazzy/source_declaration.rb +22 -5
  32. data/lib/jazzy/source_document.rb +8 -5
  33. data/lib/jazzy/source_host.rb +111 -0
  34. data/lib/jazzy/source_mark.rb +8 -6
  35. data/lib/jazzy/source_module.rb +6 -6
  36. data/lib/jazzy/sourcekitten.rb +155 -81
  37. data/lib/jazzy/stats.rb +14 -3
  38. data/lib/jazzy/symbol_graph/constraint.rb +5 -1
  39. data/lib/jazzy/symbol_graph/ext_node.rb +3 -1
  40. data/lib/jazzy/symbol_graph/graph.rb +19 -12
  41. data/lib/jazzy/symbol_graph/relationship.rb +9 -0
  42. data/lib/jazzy/symbol_graph/sym_node.rb +25 -7
  43. data/lib/jazzy/symbol_graph/symbol.rb +54 -25
  44. data/lib/jazzy/symbol_graph.rb +43 -32
  45. data/lib/jazzy/themes/apple/assets/css/highlight.css.scss +63 -59
  46. data/lib/jazzy/themes/apple/assets/css/jazzy.css.scss +5 -1
  47. data/lib/jazzy/themes/apple/assets/js/jazzy.js +4 -0
  48. data/lib/jazzy/themes/apple/assets/js/jazzy.search.js +4 -0
  49. data/lib/jazzy/themes/apple/templates/doc.mustache +4 -5
  50. data/lib/jazzy/themes/apple/templates/footer.mustache +1 -1
  51. data/lib/jazzy/themes/apple/templates/header.mustache +6 -6
  52. data/lib/jazzy/themes/apple/templates/task.mustache +6 -11
  53. data/lib/jazzy/themes/fullwidth/assets/css/highlight.css.scss +63 -59
  54. data/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss +6 -2
  55. data/lib/jazzy/themes/fullwidth/assets/js/jazzy.js +4 -0
  56. data/lib/jazzy/themes/fullwidth/assets/js/jazzy.search.js +4 -0
  57. data/lib/jazzy/themes/fullwidth/templates/doc.mustache +4 -5
  58. data/lib/jazzy/themes/fullwidth/templates/footer.mustache +1 -1
  59. data/lib/jazzy/themes/fullwidth/templates/header.mustache +8 -8
  60. data/lib/jazzy/themes/fullwidth/templates/task.mustache +6 -11
  61. data/lib/jazzy/themes/jony/assets/css/highlight.css.scss +63 -59
  62. data/lib/jazzy/themes/jony/assets/css/jazzy.css.scss +5 -1
  63. data/lib/jazzy/themes/jony/assets/js/jazzy.js +4 -0
  64. data/lib/jazzy/themes/jony/templates/doc.mustache +4 -5
  65. data/lib/jazzy/themes/jony/templates/footer.mustache +1 -1
  66. data/lib/jazzy/themes/jony/templates/header.mustache +6 -6
  67. data/lib/jazzy/themes/jony/templates/task.mustache +6 -11
  68. data/lib/jazzy.rb +2 -0
  69. data/spec/integration_spec.rb +46 -42
  70. data/spec/spec_helper/pre_flight.rb +2 -0
  71. data/spec/spec_helper.rb +3 -1
  72. metadata +32 -16
  73. data/lib/jazzy/themes/fullwidth/assets/img/gh.png +0 -0
  74. data/lib/jazzy/themes/jony/assets/img/gh.png +0 -0
  75. data/spec/sourcekitten_spec.rb +0 -6
@@ -1,3 +1,7 @@
1
+ // Jazzy - https://github.com/realm/jazzy
2
+ // Copyright Realm Inc.
3
+ // SPDX-License-Identifier: MIT
4
+
1
5
  window.jazzy = {'docset': false}
2
6
  if (typeof window.dash != 'undefined') {
3
7
  document.documentElement.className += ' dash'
@@ -1,3 +1,7 @@
1
+ // Jazzy - https://github.com/realm/jazzy
2
+ // Copyright Realm Inc.
3
+ // SPDX-License-Identifier: MIT
4
+
1
5
  $(function(){
2
6
  var $typeahead = $('[data-typeahead]');
3
7
  var $form = $typeahead.parents('form');
@@ -29,7 +29,7 @@
29
29
  <div class="content-wrapper">
30
30
  <p id="breadcrumbs">
31
31
  <a href="{{path_to_root}}index.html">{{module_name}} Reference</a>
32
- <img id="carat" src="{{path_to_root}}img/carat.png" />
32
+ <img id="carat" src="{{path_to_root}}img/carat.png" alt=""/>
33
33
  {{name}} {{kind}} Reference
34
34
  </p>
35
35
  </div>
@@ -73,11 +73,11 @@
73
73
  {{{return}}}
74
74
  </div>
75
75
  {{/return}}
76
- {{#github_token_url}}
76
+ {{#source_host_item_url}}
77
77
  <div class="slightly-smaller">
78
- <a href="{{{github_token_url}}}">Show on GitHub</a>
78
+ <a href="{{{.}}}">Show on {{source_host_name}}</a>
79
79
  </div>
80
- {{/github_token_url}}
80
+ {{/source_host_item_url}}
81
81
  </section>
82
82
  {{> tasks}}
83
83
  </section>
@@ -85,5 +85,4 @@
85
85
  </article>
86
86
  </div>
87
87
  </body>
88
- </div>
89
88
  </html>
@@ -1,4 +1,4 @@
1
1
  <section id="footer">
2
2
  {{{copyright}}}
3
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
3
+ <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
4
4
  </section>
@@ -1,18 +1,18 @@
1
1
  <header>
2
2
  <div class="content-wrapper">
3
3
  <p><a href="{{path_to_root}}index.html">{{docs_title}}</a>{{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}</p>
4
- {{#github_url}}
5
- <p class="header-right"><a href="{{github_url}}"><img src="{{path_to_root}}img/gh.png"/>View on GitHub</a></p>
6
- {{/github_url}}
4
+ {{#source_host_url}}
5
+ <p class="header-right"><a href="{{.}}"><img src="{{path_to_root}}img/{{source_host_image}}" alt="{{source_host_name}}"/>View on {{source_host_name}}</a></p>
6
+ {{/source_host_url}}
7
7
  {{#dash_url}}
8
- <p class="header-right"><a href="{{dash_url}}"><img src="{{path_to_root}}img/dash.png"/>Install in Dash</a></p>
8
+ <p class="header-right"><a href="{{dash_url}}"><img src="{{path_to_root}}img/dash.png" alt="Dash"/>Install in Dash</a></p>
9
9
  {{/dash_url}}
10
10
  {{^disable_search}}
11
- <p class="header-right">
11
+ <div class="header-right">
12
12
  <form role="search" action="{{path_to_root}}search.json">
13
13
  <input type="text" placeholder="Search documentation" data-typeahead>
14
14
  </form>
15
- </p>
15
+ </div>
16
16
  {{/disable_search}}
17
17
  </div>
18
18
  </header>
@@ -28,16 +28,11 @@
28
28
  <a class="token discouraged" href="#/{{usr}}">{{{name_html}}}</a>
29
29
  {{/usage_discouraged}}
30
30
  </code>
31
- {{#default_impl_abstract}}
31
+ {{#declaration_note}}
32
32
  <span class="declaration-note">
33
- Default implementation
33
+ {{.}}
34
34
  </span>
35
- {{/default_impl_abstract}}
36
- {{#from_protocol_extension}}
37
- <span class="declaration-note">
38
- Extension method
39
- </span>
40
- {{/from_protocol_extension}}
35
+ {{/declaration_note}}
41
36
  </div>
42
37
  <div class="height-container">
43
38
  <div class="pointer-container"></div>
@@ -91,11 +86,11 @@
91
86
  {{{return}}}
92
87
  </div>
93
88
  {{/return}}
94
- {{#github_token_url}}
89
+ {{#source_host_item_url}}
95
90
  <div class="slightly-smaller">
96
- <a href="{{{github_token_url}}}">Show on GitHub</a>
91
+ <a href="{{{.}}}">Show on {{source_host_name}}</a>
97
92
  </div>
98
- {{/github_token_url}}
93
+ {{/source_host_item_url}}
99
94
  </section>
100
95
  {{/direct_link}}
101
96
  </div>
@@ -1,63 +1,67 @@
1
+ /*! Jazzy - https://github.com/realm/jazzy
2
+ * Copyright Realm Inc.
3
+ * SPDX-License-Identifier: MIT
4
+ */
1
5
  /* Credit to https://gist.github.com/wataru420/2048287 */
2
6
 
3
7
  .highlight {
4
- .c { color: #999988; font-style: italic } /* Comment */
5
- .err { color: #a61717; background-color: #e3d2d2 } /* Error */
6
- .k { color: #000000; font-weight: bold } /* Keyword */
7
- .o { color: #000000; font-weight: bold } /* Operator */
8
- .cm { color: #999988; font-style: italic } /* Comment.Multiline */
9
- .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
10
- .c1 { color: #999988; font-style: italic } /* Comment.Single */
11
- .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
12
- .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
13
- .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
14
- .ge { color: #000000; font-style: italic } /* Generic.Emph */
15
- .gr { color: #aa0000 } /* Generic.Error */
16
- .gh { color: #999999 } /* Generic.Heading */
17
- .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
18
- .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
19
- .go { color: #888888 } /* Generic.Output */
20
- .gp { color: #555555 } /* Generic.Prompt */
21
- .gs { font-weight: bold } /* Generic.Strong */
22
- .gu { color: #aaaaaa } /* Generic.Subheading */
23
- .gt { color: #aa0000 } /* Generic.Traceback */
24
- .kc { color: #000000; font-weight: bold } /* Keyword.Constant */
25
- .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
26
- .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
27
- .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
28
- .kt { color: #445588; } /* Keyword.Type */
29
- .m { color: #009999 } /* Literal.Number */
30
- .s { color: #d14 } /* Literal.String */
31
- .na { color: #008080 } /* Name.Attribute */
32
- .nb { color: #0086B3 } /* Name.Builtin */
33
- .nc { color: #445588; font-weight: bold } /* Name.Class */
34
- .no { color: #008080 } /* Name.Constant */
35
- .ni { color: #800080 } /* Name.Entity */
36
- .ne { color: #990000; font-weight: bold } /* Name.Exception */
37
- .nf { color: #990000; } /* Name.Function */
38
- .nn { color: #555555 } /* Name.Namespace */
39
- .nt { color: #000080 } /* Name.Tag */
40
- .nv { color: #008080 } /* Name.Variable */
41
- .ow { color: #000000; font-weight: bold } /* Operator.Word */
42
- .w { color: #bbbbbb } /* Text.Whitespace */
43
- .mf { color: #009999 } /* Literal.Number.Float */
44
- .mh { color: #009999 } /* Literal.Number.Hex */
45
- .mi { color: #009999 } /* Literal.Number.Integer */
46
- .mo { color: #009999 } /* Literal.Number.Oct */
47
- .sb { color: #d14 } /* Literal.String.Backtick */
48
- .sc { color: #d14 } /* Literal.String.Char */
49
- .sd { color: #d14 } /* Literal.String.Doc */
50
- .s2 { color: #d14 } /* Literal.String.Double */
51
- .se { color: #d14 } /* Literal.String.Escape */
52
- .sh { color: #d14 } /* Literal.String.Heredoc */
53
- .si { color: #d14 } /* Literal.String.Interpol */
54
- .sx { color: #d14 } /* Literal.String.Other */
55
- .sr { color: #009926 } /* Literal.String.Regex */
56
- .s1 { color: #d14 } /* Literal.String.Single */
57
- .ss { color: #990073 } /* Literal.String.Symbol */
58
- .bp { color: #999999 } /* Name.Builtin.Pseudo */
59
- .vc { color: #008080 } /* Name.Variable.Class */
60
- .vg { color: #008080 } /* Name.Variable.Global */
61
- .vi { color: #008080 } /* Name.Variable.Instance */
62
- .il { color: #009999 } /* Literal.Number.Integer.Long */
8
+ .c { color: #999988; font-style: italic } // Comment
9
+ .err { color: #a61717; background-color: #e3d2d2 } // Error
10
+ .k { color: #000000; font-weight: bold } // Keyword
11
+ .o { color: #000000; font-weight: bold } // Operator
12
+ .cm { color: #999988; font-style: italic } // Comment.Multiline
13
+ .cp { color: #999999; font-weight: bold } // Comment.Preproc
14
+ .c1 { color: #999988; font-style: italic } // Comment.Single
15
+ .cs { color: #999999; font-weight: bold; font-style: italic } // Comment.Special
16
+ .gd { color: #000000; background-color: #ffdddd } // Generic.Deleted
17
+ .gd .x { color: #000000; background-color: #ffaaaa } // Generic.Deleted.Specific
18
+ .ge { color: #000000; font-style: italic } // Generic.Emph
19
+ .gr { color: #aa0000 } // Generic.Error
20
+ .gh { color: #999999 } // Generic.Heading
21
+ .gi { color: #000000; background-color: #ddffdd } // Generic.Inserted
22
+ .gi .x { color: #000000; background-color: #aaffaa } // Generic.Inserted.Specific
23
+ .go { color: #888888 } // Generic.Output
24
+ .gp { color: #555555 } // Generic.Prompt
25
+ .gs { font-weight: bold } // Generic.Strong
26
+ .gu { color: #aaaaaa } // Generic.Subheading
27
+ .gt { color: #aa0000 } // Generic.Traceback
28
+ .kc { color: #000000; font-weight: bold } // Keyword.Constant
29
+ .kd { color: #000000; font-weight: bold } // Keyword.Declaration
30
+ .kp { color: #000000; font-weight: bold } // Keyword.Pseudo
31
+ .kr { color: #000000; font-weight: bold } // Keyword.Reserved
32
+ .kt { color: #445588; } // Keyword.Type
33
+ .m { color: #009999 } // Literal.Number
34
+ .s { color: #d14 } // Literal.String
35
+ .na { color: #008080 } // Name.Attribute
36
+ .nb { color: #0086B3 } // Name.Builtin
37
+ .nc { color: #445588; font-weight: bold } // Name.Class
38
+ .no { color: #008080 } // Name.Constant
39
+ .ni { color: #800080 } // Name.Entity
40
+ .ne { color: #990000; font-weight: bold } // Name.Exception
41
+ .nf { color: #990000; } // Name.Function
42
+ .nn { color: #555555 } // Name.Namespace
43
+ .nt { color: #000080 } // Name.Tag
44
+ .nv { color: #008080 } // Name.Variable
45
+ .ow { color: #000000; font-weight: bold } // Operator.Word
46
+ .w { color: #bbbbbb } // Text.Whitespace
47
+ .mf { color: #009999 } // Literal.Number.Float
48
+ .mh { color: #009999 } // Literal.Number.Hex
49
+ .mi { color: #009999 } // Literal.Number.Integer
50
+ .mo { color: #009999 } // Literal.Number.Oct
51
+ .sb { color: #d14 } // Literal.String.Backtick
52
+ .sc { color: #d14 } // Literal.String.Char
53
+ .sd { color: #d14 } // Literal.String.Doc
54
+ .s2 { color: #d14 } // Literal.String.Double
55
+ .se { color: #d14 } // Literal.String.Escape
56
+ .sh { color: #d14 } // Literal.String.Heredoc
57
+ .si { color: #d14 } // Literal.String.Interpol
58
+ .sx { color: #d14 } // Literal.String.Other
59
+ .sr { color: #009926 } // Literal.String.Regex
60
+ .s1 { color: #d14 } // Literal.String.Single
61
+ .ss { color: #990073 } // Literal.String.Symbol
62
+ .bp { color: #999999 } // Name.Builtin.Pseudo
63
+ .vc { color: #008080 } // Name.Variable.Class
64
+ .vg { color: #008080 } // Name.Variable.Global
65
+ .vi { color: #008080 } // Name.Variable.Instance
66
+ .il { color: #009999 } // Literal.Number.Integer.Long
63
67
  }
@@ -1,3 +1,7 @@
1
+ /*! Jazzy - https://github.com/realm/jazzy
2
+ * Copyright Realm Inc.
3
+ * SPDX-License-Identifier: MIT
4
+ */
1
5
  // ===========================================================================
2
6
  //
3
7
  // Variables
@@ -268,8 +272,8 @@ pre code {
268
272
  }
269
273
 
270
274
  .header-icon {
271
- padding-right: 6px;
272
- vertical-align: -4px;
275
+ padding-right: 2px;
276
+ vertical-align: -3px;
273
277
  height: 16px;
274
278
  }
275
279
 
@@ -1,3 +1,7 @@
1
+ // Jazzy - https://github.com/realm/jazzy
2
+ // Copyright Realm Inc.
3
+ // SPDX-License-Identifier: MIT
4
+
1
5
  window.jazzy = {'docset': false}
2
6
  if (typeof window.dash != 'undefined') {
3
7
  document.documentElement.className += ' dash'
@@ -1,3 +1,7 @@
1
+ // Jazzy - https://github.com/realm/jazzy
2
+ // Copyright Realm Inc.
3
+ // SPDX-License-Identifier: MIT
4
+
1
5
  $(function(){
2
6
  var $typeahead = $('[data-typeahead]');
3
7
  var $form = $typeahead.parents('form');
@@ -32,7 +32,7 @@
32
32
 
33
33
  <p class="breadcrumbs">
34
34
  <a class="breadcrumb" href="{{path_to_root}}index.html">{{module_name}} Reference</a>
35
- <img class="carat" src="{{path_to_root}}img/carat.png" />
35
+ <img class="carat" src="{{path_to_root}}img/carat.png" alt=""/>
36
36
  {{name}} {{kind}} Reference
37
37
  </p>
38
38
 
@@ -77,11 +77,11 @@
77
77
  {{{return}}}
78
78
  </div>
79
79
  {{/return}}
80
- {{#github_token_url}}
80
+ {{#source_host_item_url}}
81
81
  <div class="slightly-smaller">
82
- <a href="{{{github_token_url}}}">Show on GitHub</a>
82
+ <a href="{{{.}}}">Show on {{source_host_name}}</a>
83
83
  </div>
84
- {{/github_token_url}}
84
+ {{/source_host_item_url}}
85
85
  </div>
86
86
  </section>
87
87
 
@@ -91,5 +91,4 @@
91
91
  </div>
92
92
  {{> footer}}
93
93
  </body>
94
- </div>
95
94
  </html>
@@ -1,4 +1,4 @@
1
1
  <section class="footer">
2
2
  {{{copyright}}}
3
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
3
+ <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
4
4
  </section>
@@ -7,26 +7,26 @@
7
7
  </p>
8
8
 
9
9
  {{^disable_search}}
10
- <p class="header-col--secondary">
10
+ <div class="header-col--secondary">
11
11
  <form role="search" action="{{path_to_root}}search.json">
12
12
  <input type="text" placeholder="Search documentation" data-typeahead>
13
13
  </form>
14
- </p>
14
+ </div>
15
15
  {{/disable_search}}
16
16
 
17
- {{#github_url}}
17
+ {{#source_host_url}}
18
18
  <p class="header-col header-col--secondary">
19
- <a class="header-link" href="{{github_url}}">
20
- <img class="header-icon" src="{{path_to_root}}img/gh.png"/>
21
- View on GitHub
19
+ <a class="header-link" href="{{.}}">
20
+ <img class="header-icon" src="{{path_to_root}}img/{{source_host_image}}" alt="{{source_host_name}}"/>
21
+ View on {{source_host_name}}
22
22
  </a>
23
23
  </p>
24
- {{/github_url}}
24
+ {{/source_host_url}}
25
25
 
26
26
  {{#dash_url}}
27
27
  <p class="header-col header-col--secondary">
28
28
  <a class="header-link" href="{{dash_url}}">
29
- <img class="header-icon" src="{{path_to_root}}img/dash.png"/>
29
+ <img class="header-icon" src="{{path_to_root}}img/dash.png" alt="Dash"/>
30
30
  Install in Dash
31
31
  </a>
32
32
  </p>
@@ -28,16 +28,11 @@
28
28
  <a class="token discouraged" href="#/{{usr}}">{{{name_html}}}</a>
29
29
  {{/usage_discouraged}}
30
30
  </code>
31
- {{#default_impl_abstract}}
31
+ {{#declaration_note}}
32
32
  <span class="declaration-note">
33
- Default implementation
33
+ {{.}}
34
34
  </span>
35
- {{/default_impl_abstract}}
36
- {{#from_protocol_extension}}
37
- <span class="declaration-note">
38
- Extension method
39
- </span>
40
- {{/from_protocol_extension}}
35
+ {{/declaration_note}}
41
36
  </div>
42
37
  <div class="height-container">
43
38
  <div class="pointer-container"></div>
@@ -91,11 +86,11 @@
91
86
  {{{return}}}
92
87
  </div>
93
88
  {{/return}}
94
- {{#github_token_url}}
89
+ {{#source_host_item_url}}
95
90
  <div class="slightly-smaller">
96
- <a href="{{{github_token_url}}}">Show on GitHub</a>
91
+ <a href="{{{.}}}">Show on {{source_host_name}}</a>
97
92
  </div>
98
- {{/github_token_url}}
93
+ {{/source_host_item_url}}
99
94
  </section>
100
95
  {{/direct_link}}
101
96
  </div>
@@ -1,63 +1,67 @@
1
+ /*! Jazzy - https://github.com/realm/jazzy
2
+ * Copyright Realm Inc.
3
+ * SPDX-License-Identifier: MIT
4
+ */
1
5
  /* Credit to https://gist.github.com/wataru420/2048287 */
2
6
 
3
7
  .highlight {
4
- .c { color: #999988; font-style: italic } /* Comment */
5
- .err { color: #a61717; background-color: #e3d2d2 } /* Error */
6
- .k { color: #000000; font-weight: bold } /* Keyword */
7
- .o { color: #000000; font-weight: bold } /* Operator */
8
- .cm { color: #999988; font-style: italic } /* Comment.Multiline */
9
- .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
10
- .c1 { color: #999988; font-style: italic } /* Comment.Single */
11
- .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
12
- .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
13
- .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
14
- .ge { color: #000000; font-style: italic } /* Generic.Emph */
15
- .gr { color: #aa0000 } /* Generic.Error */
16
- .gh { color: #999999 } /* Generic.Heading */
17
- .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
18
- .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
19
- .go { color: #888888 } /* Generic.Output */
20
- .gp { color: #555555 } /* Generic.Prompt */
21
- .gs { font-weight: bold } /* Generic.Strong */
22
- .gu { color: #aaaaaa } /* Generic.Subheading */
23
- .gt { color: #aa0000 } /* Generic.Traceback */
24
- .kc { color: #000000; font-weight: bold } /* Keyword.Constant */
25
- .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
26
- .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
27
- .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
28
- .kt { color: #445588; } /* Keyword.Type */
29
- .m { color: #009999 } /* Literal.Number */
30
- .s { color: #d14 } /* Literal.String */
31
- .na { color: #008080 } /* Name.Attribute */
32
- .nb { color: #0086B3 } /* Name.Builtin */
33
- .nc { color: #445588; font-weight: bold } /* Name.Class */
34
- .no { color: #008080 } /* Name.Constant */
35
- .ni { color: #800080 } /* Name.Entity */
36
- .ne { color: #990000; font-weight: bold } /* Name.Exception */
37
- .nf { color: #990000; } /* Name.Function */
38
- .nn { color: #555555 } /* Name.Namespace */
39
- .nt { color: #000080 } /* Name.Tag */
40
- .nv { color: #008080 } /* Name.Variable */
41
- .ow { color: #000000; font-weight: bold } /* Operator.Word */
42
- .w { color: #bbbbbb } /* Text.Whitespace */
43
- .mf { color: #009999 } /* Literal.Number.Float */
44
- .mh { color: #009999 } /* Literal.Number.Hex */
45
- .mi { color: #009999 } /* Literal.Number.Integer */
46
- .mo { color: #009999 } /* Literal.Number.Oct */
47
- .sb { color: #d14 } /* Literal.String.Backtick */
48
- .sc { color: #d14 } /* Literal.String.Char */
49
- .sd { color: #d14 } /* Literal.String.Doc */
50
- .s2 { color: #d14 } /* Literal.String.Double */
51
- .se { color: #d14 } /* Literal.String.Escape */
52
- .sh { color: #d14 } /* Literal.String.Heredoc */
53
- .si { color: #d14 } /* Literal.String.Interpol */
54
- .sx { color: #d14 } /* Literal.String.Other */
55
- .sr { color: #009926 } /* Literal.String.Regex */
56
- .s1 { color: #d14 } /* Literal.String.Single */
57
- .ss { color: #990073 } /* Literal.String.Symbol */
58
- .bp { color: #999999 } /* Name.Builtin.Pseudo */
59
- .vc { color: #008080 } /* Name.Variable.Class */
60
- .vg { color: #008080 } /* Name.Variable.Global */
61
- .vi { color: #008080 } /* Name.Variable.Instance */
62
- .il { color: #009999 } /* Literal.Number.Integer.Long */
8
+ .c { color: #999988; font-style: italic } // Comment
9
+ .err { color: #a61717; background-color: #e3d2d2 } // Error
10
+ .k { color: #000000; font-weight: bold } // Keyword
11
+ .o { color: #000000; font-weight: bold } // Operator
12
+ .cm { color: #999988; font-style: italic } // Comment.Multiline
13
+ .cp { color: #999999; font-weight: bold } // Comment.Preproc
14
+ .c1 { color: #999988; font-style: italic } // Comment.Single
15
+ .cs { color: #999999; font-weight: bold; font-style: italic } // Comment.Special
16
+ .gd { color: #000000; background-color: #ffdddd } // Generic.Deleted
17
+ .gd .x { color: #000000; background-color: #ffaaaa } // Generic.Deleted.Specific
18
+ .ge { color: #000000; font-style: italic } // Generic.Emph
19
+ .gr { color: #aa0000 } // Generic.Error
20
+ .gh { color: #999999 } // Generic.Heading
21
+ .gi { color: #000000; background-color: #ddffdd } // Generic.Inserted
22
+ .gi .x { color: #000000; background-color: #aaffaa } // Generic.Inserted.Specific
23
+ .go { color: #888888 } // Generic.Output
24
+ .gp { color: #555555 } // Generic.Prompt
25
+ .gs { font-weight: bold } // Generic.Strong
26
+ .gu { color: #aaaaaa } // Generic.Subheading
27
+ .gt { color: #aa0000 } // Generic.Traceback
28
+ .kc { color: #000000; font-weight: bold } // Keyword.Constant
29
+ .kd { color: #000000; font-weight: bold } // Keyword.Declaration
30
+ .kp { color: #000000; font-weight: bold } // Keyword.Pseudo
31
+ .kr { color: #000000; font-weight: bold } // Keyword.Reserved
32
+ .kt { color: #445588; } // Keyword.Type
33
+ .m { color: #009999 } // Literal.Number
34
+ .s { color: #d14 } // Literal.String
35
+ .na { color: #008080 } // Name.Attribute
36
+ .nb { color: #0086B3 } // Name.Builtin
37
+ .nc { color: #445588; font-weight: bold } // Name.Class
38
+ .no { color: #008080 } // Name.Constant
39
+ .ni { color: #800080 } // Name.Entity
40
+ .ne { color: #990000; font-weight: bold } // Name.Exception
41
+ .nf { color: #990000; } // Name.Function
42
+ .nn { color: #555555 } // Name.Namespace
43
+ .nt { color: #000080 } // Name.Tag
44
+ .nv { color: #008080 } // Name.Variable
45
+ .ow { color: #000000; font-weight: bold } // Operator.Word
46
+ .w { color: #bbbbbb } // Text.Whitespace
47
+ .mf { color: #009999 } // Literal.Number.Float
48
+ .mh { color: #009999 } // Literal.Number.Hex
49
+ .mi { color: #009999 } // Literal.Number.Integer
50
+ .mo { color: #009999 } // Literal.Number.Oct
51
+ .sb { color: #d14 } // Literal.String.Backtick
52
+ .sc { color: #d14 } // Literal.String.Char
53
+ .sd { color: #d14 } // Literal.String.Doc
54
+ .s2 { color: #d14 } // Literal.String.Double
55
+ .se { color: #d14 } // Literal.String.Escape
56
+ .sh { color: #d14 } // Literal.String.Heredoc
57
+ .si { color: #d14 } // Literal.String.Interpol
58
+ .sx { color: #d14 } // Literal.String.Other
59
+ .sr { color: #009926 } // Literal.String.Regex
60
+ .s1 { color: #d14 } // Literal.String.Single
61
+ .ss { color: #990073 } // Literal.String.Symbol
62
+ .bp { color: #999999 } // Name.Builtin.Pseudo
63
+ .vc { color: #008080 } // Name.Variable.Class
64
+ .vg { color: #008080 } // Name.Variable.Global
65
+ .vi { color: #008080 } // Name.Variable.Instance
66
+ .il { color: #009999 } // Literal.Number.Integer.Long
63
67
  }
@@ -1,3 +1,7 @@
1
+ /*! Jazzy - https://github.com/realm/jazzy
2
+ * Copyright Realm Inc.
3
+ * SPDX-License-Identifier: MIT
4
+ */
1
5
  ////////////////////////////////
2
6
  // Constants
3
7
  ////////////////////////////////
@@ -212,7 +216,7 @@ header {
212
216
  z-index: 3;
213
217
  img {
214
218
  padding-right: 6px;
215
- vertical-align: -4px;
219
+ vertical-align: -2px;
216
220
  height: 16px;
217
221
  }
218
222
  a {
@@ -1,3 +1,7 @@
1
+ // Jazzy - https://github.com/realm/jazzy
2
+ // Copyright Realm Inc.
3
+ // SPDX-License-Identifier: MIT
4
+
1
5
  window.jazzy = {'docset': false}
2
6
  if (typeof window.dash != 'undefined') {
3
7
  document.documentElement.className += ' dash'
@@ -27,7 +27,7 @@
27
27
  <p id="breadcrumbs">
28
28
  <span class="no-mobile">
29
29
  <a href="{{path_to_root}}index.html">{{module_name}} Reference</a>
30
- <img id="carat" src="{{path_to_root}}img/carat.png" />
30
+ <img id="carat" src="{{path_to_root}}img/carat.png" alt=""/>
31
31
  </span>
32
32
  {{name}} {{kind}} Reference
33
33
  </p>
@@ -73,11 +73,11 @@
73
73
  {{{return}}}
74
74
  </div>
75
75
  {{/return}}
76
- {{#github_token_url}}
76
+ {{#source_host_item_url}}
77
77
  <div class="slightly-smaller">
78
- <a href="{{{github_token_url}}}">Show on GitHub</a>
78
+ <a href="{{{.}}}">Show on {{source_host_name}}</a>
79
79
  </div>
80
- {{/github_token_url}}
80
+ {{/source_host_item_url}}
81
81
  </section>
82
82
  {{> tasks}}
83
83
  </section>
@@ -91,5 +91,4 @@
91
91
  </div>
92
92
  </div>
93
93
  </body>
94
- </div>
95
94
  </html>
@@ -1,4 +1,4 @@
1
1
  <section id="footer">
2
2
  {{{copyright}}}
3
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
3
+ <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
4
4
  </section>
@@ -5,19 +5,19 @@
5
5
  <span class="no-mobile">{{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}</span>
6
6
  </p>
7
7
 
8
- {{#github_url}}
8
+ {{#source_host_url}}
9
9
  <p class="header-right">
10
- <a href="{{github_url}}">
11
- <img src="{{path_to_root}}img/gh.png"/>
12
- <span class="no-mobile">View on GitHub</span>
10
+ <a href="{{.}}">
11
+ <img src="{{path_to_root}}img/{{source_host_image}}" alt="{{source_host_name}}"/>
12
+ <span class="no-mobile">View on {{source_host_name}}</span>
13
13
  </a>
14
14
  </p>
15
- {{/github_url}}
15
+ {{/source_host_url}}
16
16
 
17
17
  {{#dash_url}}
18
18
  <p class="header-right">
19
19
  <a href="{{dash_url}}">
20
- <img src="{{path_to_root}}img/dash.png"/>
20
+ <img src="{{path_to_root}}img/dash.png" alt="Dash"/>
21
21
  <span class="no-mobile">Install in Dash</span>
22
22
  </a>
23
23
  </p>