jazzy 0.13.4 → 0.13.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/CHANGELOG.md +27 -0
- data/Gemfile.lock +13 -13
- data/README.md +7 -0
- data/Rakefile +8 -3
- data/lib/jazzy/config.rb +7 -0
- data/lib/jazzy/doc_builder.rb +6 -0
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/source_declaration.rb +15 -2
- data/lib/jazzy/source_declaration/type.rb +30 -0
- data/lib/jazzy/sourcekitten.rb +2 -1
- data/lib/jazzy/themes/apple/assets/css/jazzy.css.scss +75 -2
- data/lib/jazzy/themes/apple/assets/img/spinner.gif +0 -0
- data/lib/jazzy/themes/apple/assets/js/jazzy.search.js +70 -0
- data/lib/jazzy/themes/apple/assets/js/lunr.min.js +6 -0
- data/lib/jazzy/themes/apple/assets/js/typeahead.jquery.js +1694 -0
- data/lib/jazzy/themes/apple/templates/doc.mustache +35 -0
- data/lib/jazzy/themes/apple/templates/header.mustache +7 -0
- data/lib/jazzy/themes/apple/templates/task.mustache +1 -1
- data/lib/jazzy/themes/fullwidth/templates/doc.mustache +30 -0
- data/lib/jazzy/themes/fullwidth/templates/task.mustache +1 -1
- data/lib/jazzy/themes/jony/assets/css/jazzy.css.scss +8 -0
- data/lib/jazzy/themes/jony/templates/doc.mustache +30 -0
- data/lib/jazzy/themes/jony/templates/task.mustache +1 -1
- metadata +6 -2
|
@@ -14,6 +14,11 @@
|
|
|
14
14
|
{{/enable_katex}}
|
|
15
15
|
<script src="{{path_to_root}}js/jazzy.js" defer></script>
|
|
16
16
|
{{{custom_head}}}
|
|
17
|
+
{{^disable_search}}
|
|
18
|
+
<script src="{{path_to_root}}js/lunr.min.js" defer></script>
|
|
19
|
+
<script src="{{path_to_root}}js/typeahead.jquery.js" defer></script>
|
|
20
|
+
<script src="{{path_to_root}}js/jazzy.search.js" defer></script>
|
|
21
|
+
{{/disable_search}}
|
|
17
22
|
</head>
|
|
18
23
|
<body>
|
|
19
24
|
{{#dash_type}}
|
|
@@ -38,11 +43,41 @@
|
|
|
38
43
|
{{#declaration}}
|
|
39
44
|
<div class="declaration">
|
|
40
45
|
<div class="language">
|
|
46
|
+
{{#other_language_declaration}}<p class="aside-title">{{language}}</p>{{/other_language_declaration}}
|
|
41
47
|
{{{declaration}}}
|
|
42
48
|
</div>
|
|
49
|
+
{{#other_language_declaration}}
|
|
50
|
+
<div class="language">
|
|
51
|
+
<p class="aside-title">Swift</p>
|
|
52
|
+
{{{other_language_declaration}}}
|
|
53
|
+
</div>
|
|
54
|
+
{{/other_language_declaration}}
|
|
43
55
|
</div>
|
|
44
56
|
{{/declaration}}
|
|
45
57
|
{{{overview}}}
|
|
58
|
+
{{#parameters.any?}}
|
|
59
|
+
<div>
|
|
60
|
+
<h4>Parameters</h4>
|
|
61
|
+
<table class="graybox">
|
|
62
|
+
<tbody>
|
|
63
|
+
{{#parameters}}
|
|
64
|
+
{{> parameter}}
|
|
65
|
+
{{/parameters}}
|
|
66
|
+
</tbody>
|
|
67
|
+
</table>
|
|
68
|
+
</div>
|
|
69
|
+
{{/parameters.any?}}
|
|
70
|
+
{{#return}}
|
|
71
|
+
<div>
|
|
72
|
+
<h4>Return Value</h4>
|
|
73
|
+
{{{return}}}
|
|
74
|
+
</div>
|
|
75
|
+
{{/return}}
|
|
76
|
+
{{#github_token_url}}
|
|
77
|
+
<div class="slightly-smaller">
|
|
78
|
+
<a href="{{{github_token_url}}}">Show on GitHub</a>
|
|
79
|
+
</div>
|
|
80
|
+
{{/github_token_url}}
|
|
46
81
|
</section>
|
|
47
82
|
{{> tasks}}
|
|
48
83
|
</section>
|
|
@@ -7,5 +7,12 @@
|
|
|
7
7
|
{{#dash_url}}
|
|
8
8
|
<p class="header-right"><a href="{{dash_url}}"><img src="{{path_to_root}}img/dash.png"/>Install in Dash</a></p>
|
|
9
9
|
{{/dash_url}}
|
|
10
|
+
{{^disable_search}}
|
|
11
|
+
<p class="header-right">
|
|
12
|
+
<form role="search" action="{{path_to_root}}search.json">
|
|
13
|
+
<input type="text" placeholder="Search documentation" data-typeahead>
|
|
14
|
+
</form>
|
|
15
|
+
</p>
|
|
16
|
+
{{/disable_search}}
|
|
10
17
|
</div>
|
|
11
18
|
</header>
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
<a name="/{{usr}}"></a>
|
|
18
18
|
<a name="//apple_ref/{{language_stub}}/{{dash_type}}/{{name}}" class="dashAnchor"></a>
|
|
19
19
|
{{#direct_link}}
|
|
20
|
-
<a class="direct-link" href="{{url}}">{{name}}</a>
|
|
20
|
+
<a class="direct-link{{#usage_discouraged}} discouraged{{/usage_discouraged}}" href="{{{path_to_root}}}{{{url}}}">{{name}}</a>
|
|
21
21
|
</code>
|
|
22
22
|
{{/direct_link}}
|
|
23
23
|
{{^direct_link}}
|
|
@@ -47,11 +47,41 @@
|
|
|
47
47
|
{{#declaration}}
|
|
48
48
|
<div class="declaration">
|
|
49
49
|
<div class="language">
|
|
50
|
+
{{#other_language_declaration}}<p class="aside-title">{{language}}</p>{{/other_language_declaration}}
|
|
50
51
|
{{{declaration}}}
|
|
51
52
|
</div>
|
|
53
|
+
{{#other_language_declaration}}
|
|
54
|
+
<div class="language">
|
|
55
|
+
<p class="aside-title">Swift</p>
|
|
56
|
+
{{{other_language_declaration}}}
|
|
57
|
+
</div>
|
|
58
|
+
{{/other_language_declaration}}
|
|
52
59
|
</div>
|
|
53
60
|
{{/declaration}}
|
|
54
61
|
{{{overview}}}
|
|
62
|
+
{{#parameters.any?}}
|
|
63
|
+
<div>
|
|
64
|
+
<h4>Parameters</h4>
|
|
65
|
+
<table class="graybox">
|
|
66
|
+
<tbody>
|
|
67
|
+
{{#parameters}}
|
|
68
|
+
{{> parameter}}
|
|
69
|
+
{{/parameters}}
|
|
70
|
+
</tbody>
|
|
71
|
+
</table>
|
|
72
|
+
</div>
|
|
73
|
+
{{/parameters.any?}}
|
|
74
|
+
{{#return}}
|
|
75
|
+
<div>
|
|
76
|
+
<h4>Return Value</h4>
|
|
77
|
+
{{{return}}}
|
|
78
|
+
</div>
|
|
79
|
+
{{/return}}
|
|
80
|
+
{{#github_token_url}}
|
|
81
|
+
<div class="slightly-smaller">
|
|
82
|
+
<a href="{{{github_token_url}}}">Show on GitHub</a>
|
|
83
|
+
</div>
|
|
84
|
+
{{/github_token_url}}
|
|
55
85
|
</div>
|
|
56
86
|
</section>
|
|
57
87
|
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
<a name="/{{usr}}"></a>
|
|
18
18
|
<a name="//apple_ref/{{language_stub}}/{{dash_type}}/{{name}}" class="dashAnchor"></a>
|
|
19
19
|
{{#direct_link}}
|
|
20
|
-
<a class="direct-link" href="{{url}}">{{name}}</a>
|
|
20
|
+
<a class="direct-link{{#usage_discouraged}} discouraged{{/usage_discouraged}}" href="{{{path_to_root}}}{{{url}}}">{{name}}</a>
|
|
21
21
|
</code>
|
|
22
22
|
{{/direct_link}}
|
|
23
23
|
{{^direct_link}}
|
|
@@ -101,11 +101,18 @@ pre, code {
|
|
|
101
101
|
word-wrap: normal;
|
|
102
102
|
}
|
|
103
103
|
|
|
104
|
+
pre {
|
|
105
|
+
line-height: 1.6;
|
|
106
|
+
}
|
|
107
|
+
|
|
104
108
|
// Links
|
|
105
109
|
|
|
106
110
|
a {
|
|
107
111
|
color: $link_color;
|
|
108
112
|
text-decoration: none;
|
|
113
|
+
code {
|
|
114
|
+
color: inherit;
|
|
115
|
+
}
|
|
109
116
|
}
|
|
110
117
|
|
|
111
118
|
// Lists
|
|
@@ -345,6 +352,7 @@ header {
|
|
|
345
352
|
}
|
|
346
353
|
|
|
347
354
|
.task-group-section {
|
|
355
|
+
margin-top: 10px;
|
|
348
356
|
border-top: $gray_border;
|
|
349
357
|
}
|
|
350
358
|
|
|
@@ -43,11 +43,41 @@
|
|
|
43
43
|
{{#declaration}}
|
|
44
44
|
<div class="declaration">
|
|
45
45
|
<div class="language">
|
|
46
|
+
{{#other_language_declaration}}<p class="aside-title">{{language}}</p>{{/other_language_declaration}}
|
|
46
47
|
{{{declaration}}}
|
|
47
48
|
</div>
|
|
49
|
+
{{#other_language_declaration}}
|
|
50
|
+
<div class="language">
|
|
51
|
+
<p class="aside-title">Swift</p>
|
|
52
|
+
{{{other_language_declaration}}}
|
|
53
|
+
</div>
|
|
54
|
+
{{/other_language_declaration}}
|
|
48
55
|
</div>
|
|
49
56
|
{{/declaration}}
|
|
50
57
|
{{{overview}}}
|
|
58
|
+
{{#parameters.any?}}
|
|
59
|
+
<div>
|
|
60
|
+
<h4>Parameters</h4>
|
|
61
|
+
<table class="graybox">
|
|
62
|
+
<tbody>
|
|
63
|
+
{{#parameters}}
|
|
64
|
+
{{> parameter}}
|
|
65
|
+
{{/parameters}}
|
|
66
|
+
</tbody>
|
|
67
|
+
</table>
|
|
68
|
+
</div>
|
|
69
|
+
{{/parameters.any?}}
|
|
70
|
+
{{#return}}
|
|
71
|
+
<div>
|
|
72
|
+
<h4>Return Value</h4>
|
|
73
|
+
{{{return}}}
|
|
74
|
+
</div>
|
|
75
|
+
{{/return}}
|
|
76
|
+
{{#github_token_url}}
|
|
77
|
+
<div class="slightly-smaller">
|
|
78
|
+
<a href="{{{github_token_url}}}">Show on GitHub</a>
|
|
79
|
+
</div>
|
|
80
|
+
{{/github_token_url}}
|
|
51
81
|
</section>
|
|
52
82
|
{{> tasks}}
|
|
53
83
|
</section>
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
<a name="/{{usr}}"></a>
|
|
18
18
|
<a name="//apple_ref/{{language_stub}}/{{dash_type}}/{{name}}" class="dashAnchor"></a>
|
|
19
19
|
{{#direct_link}}
|
|
20
|
-
<a class="direct-link" href="{{url}}">{{name}}</a>
|
|
20
|
+
<a class="direct-link{{#usage_discouraged}} discouraged{{/usage_discouraged}}" href="{{{path_to_root}}}{{{url}}}">{{name}}</a>
|
|
21
21
|
</code>
|
|
22
22
|
{{/direct_link}}
|
|
23
23
|
{{^direct_link}}
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jazzy
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.13.
|
|
4
|
+
version: 0.13.5
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- JP Simard
|
|
@@ -11,7 +11,7 @@ authors:
|
|
|
11
11
|
autorequire:
|
|
12
12
|
bindir: bin
|
|
13
13
|
cert_chain: []
|
|
14
|
-
date: 2020-
|
|
14
|
+
date: 2020-07-06 00:00:00.000000000 Z
|
|
15
15
|
dependencies:
|
|
16
16
|
- !ruby/object:Gem::Dependency
|
|
17
17
|
name: cocoapods
|
|
@@ -278,8 +278,12 @@ files:
|
|
|
278
278
|
- lib/jazzy/themes/apple/assets/img/carat.png
|
|
279
279
|
- lib/jazzy/themes/apple/assets/img/dash.png
|
|
280
280
|
- lib/jazzy/themes/apple/assets/img/gh.png
|
|
281
|
+
- lib/jazzy/themes/apple/assets/img/spinner.gif
|
|
281
282
|
- lib/jazzy/themes/apple/assets/js/jazzy.js
|
|
283
|
+
- lib/jazzy/themes/apple/assets/js/jazzy.search.js
|
|
282
284
|
- lib/jazzy/themes/apple/assets/js/jquery.min.js
|
|
285
|
+
- lib/jazzy/themes/apple/assets/js/lunr.min.js
|
|
286
|
+
- lib/jazzy/themes/apple/assets/js/typeahead.jquery.js
|
|
283
287
|
- lib/jazzy/themes/apple/templates/deprecation.mustache
|
|
284
288
|
- lib/jazzy/themes/apple/templates/doc.mustache
|
|
285
289
|
- lib/jazzy/themes/apple/templates/footer.mustache
|