just-the-docs 0.8.2 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +90 -1
- data/_includes/components/breadcrumbs.html +60 -108
- data/_includes/components/children_nav.html +72 -16
- data/_includes/components/nav/children.html +48 -0
- data/_includes/components/nav/links.html +53 -0
- data/_includes/components/nav/pages.html +23 -0
- data/_includes/{sorted_pages.html → components/nav/sorted.html} +3 -3
- data/_includes/components/site_nav.html +12 -7
- data/_includes/css/activation.scss.liquid +257 -264
- data/_layouts/default.html +8 -2
- data/_layouts/minimal.html +3 -31
- data/_sass/base.scss +2 -2
- data/_sass/code.scss +4 -4
- data/_sass/labels.scss +2 -2
- data/_sass/layout.scss +45 -29
- data/_sass/navigation.scss +2 -2
- data/_sass/support/mixins/_typography.scss +34 -14
- data/_sass/tables.scss +2 -2
- data/_sass/typography.scss +4 -4
- data/_sass/vendor/OneDarkJekyll/syntax.scss +63 -0
- data/_sass/vendor/OneLightJekyll/syntax.scss +65 -0
- data/_sass/vendor/normalize.scss/normalize.scss +7 -7
- data/assets/js/just-the-docs.js +5 -3
- data/assets/js/zzzz-search-data.json +1 -0
- data/lib/tasks/search.rake +1 -0
- metadata +7 -5
- data/_includes/components/nav.html +0 -75
@@ -5,204 +5,269 @@ pre.highlight {
|
|
5
5
|
background: #f9f9f9;
|
6
6
|
color: #383942;
|
7
7
|
}
|
8
|
+
|
8
9
|
.highlight pre {
|
9
10
|
background: #f9f9f9;
|
10
11
|
}
|
12
|
+
|
11
13
|
.highlight .hll {
|
12
14
|
background: #f9f9f9;
|
13
15
|
}
|
16
|
+
|
14
17
|
.highlight .c {
|
15
18
|
color: #9fa0a6;
|
16
19
|
font-style: italic;
|
17
20
|
}
|
21
|
+
|
18
22
|
.highlight .err {
|
19
23
|
color: #fff;
|
20
24
|
background-color: #e05151;
|
21
25
|
}
|
26
|
+
|
22
27
|
.highlight .k {
|
23
28
|
color: #a625a4;
|
24
29
|
}
|
30
|
+
|
25
31
|
.highlight .l {
|
26
32
|
color: #50a04f;
|
27
33
|
}
|
34
|
+
|
28
35
|
.highlight .n {
|
29
36
|
color: #383942;
|
30
37
|
}
|
38
|
+
|
31
39
|
.highlight .o {
|
32
40
|
color: #383942;
|
33
41
|
}
|
42
|
+
|
34
43
|
.highlight .p {
|
35
44
|
color: #383942;
|
36
45
|
}
|
46
|
+
|
37
47
|
.highlight .cm {
|
38
48
|
color: #9fa0a6;
|
39
49
|
font-style: italic;
|
40
50
|
}
|
51
|
+
|
41
52
|
.highlight .cp {
|
42
53
|
color: #9fa0a6;
|
43
54
|
font-style: italic;
|
44
55
|
}
|
56
|
+
|
45
57
|
.highlight .c1 {
|
46
58
|
color: #9fa0a6;
|
47
59
|
font-style: italic;
|
48
60
|
}
|
61
|
+
|
49
62
|
.highlight .cs {
|
50
63
|
color: #9fa0a6;
|
51
64
|
font-style: italic;
|
52
65
|
}
|
66
|
+
|
53
67
|
.highlight .ge {
|
54
68
|
font-style: italic;
|
55
69
|
}
|
70
|
+
|
56
71
|
.highlight .gs {
|
57
72
|
font-weight: 700;
|
58
73
|
}
|
74
|
+
|
59
75
|
.highlight .kc {
|
60
76
|
color: #a625a4;
|
61
77
|
}
|
78
|
+
|
62
79
|
.highlight .kd {
|
63
80
|
color: #a625a4;
|
64
81
|
}
|
82
|
+
|
65
83
|
.highlight .kn {
|
66
84
|
color: #a625a4;
|
67
85
|
}
|
86
|
+
|
68
87
|
.highlight .kp {
|
69
88
|
color: #a625a4;
|
70
89
|
}
|
90
|
+
|
71
91
|
.highlight .kr {
|
72
92
|
color: #a625a4;
|
73
93
|
}
|
94
|
+
|
74
95
|
.highlight .kt {
|
75
96
|
color: #a625a4;
|
76
97
|
}
|
98
|
+
|
77
99
|
.highlight .ld {
|
78
100
|
color: #50a04f;
|
79
101
|
}
|
102
|
+
|
80
103
|
.highlight .m {
|
81
104
|
color: #b66a00;
|
82
105
|
}
|
106
|
+
|
83
107
|
.highlight .s {
|
84
108
|
color: #50a04f;
|
85
109
|
}
|
110
|
+
|
86
111
|
.highlight .na {
|
87
112
|
color: #b66a00;
|
88
113
|
}
|
114
|
+
|
89
115
|
.highlight .nb {
|
90
116
|
color: #ca7601;
|
91
117
|
}
|
118
|
+
|
92
119
|
.highlight .nc {
|
93
120
|
color: #ca7601;
|
94
121
|
}
|
122
|
+
|
95
123
|
.highlight .no {
|
96
124
|
color: #ca7601;
|
97
125
|
}
|
126
|
+
|
98
127
|
.highlight .nd {
|
99
128
|
color: #ca7601;
|
100
129
|
}
|
130
|
+
|
101
131
|
.highlight .ni {
|
102
132
|
color: #ca7601;
|
103
133
|
}
|
134
|
+
|
104
135
|
.highlight .ne {
|
105
136
|
color: #ca7601;
|
106
137
|
}
|
138
|
+
|
107
139
|
.highlight .nf {
|
108
140
|
color: #383942;
|
109
141
|
}
|
142
|
+
|
110
143
|
.highlight .nl {
|
111
144
|
color: #ca7601;
|
112
145
|
}
|
146
|
+
|
113
147
|
.highlight .nn {
|
114
148
|
color: #383942;
|
115
149
|
}
|
150
|
+
|
116
151
|
.highlight .nx {
|
117
152
|
color: #383942;
|
118
153
|
}
|
154
|
+
|
119
155
|
.highlight .py {
|
120
156
|
color: #ca7601;
|
121
157
|
}
|
158
|
+
|
122
159
|
.highlight .nt {
|
123
160
|
color: #e35549;
|
124
161
|
}
|
162
|
+
|
125
163
|
.highlight .nv {
|
126
164
|
color: #ca7601;
|
127
165
|
}
|
166
|
+
|
128
167
|
.highlight .ow {
|
129
168
|
font-weight: 700;
|
130
169
|
}
|
170
|
+
|
131
171
|
.highlight .w {
|
132
172
|
color: #f8f8f2;
|
133
173
|
}
|
174
|
+
|
134
175
|
.highlight .mf {
|
135
176
|
color: #b66a00;
|
136
177
|
}
|
178
|
+
|
137
179
|
.highlight .mh {
|
138
180
|
color: #b66a00;
|
139
181
|
}
|
182
|
+
|
140
183
|
.highlight .mi {
|
141
184
|
color: #b66a00;
|
142
185
|
}
|
186
|
+
|
143
187
|
.highlight .mo {
|
144
188
|
color: #b66a00;
|
145
189
|
}
|
190
|
+
|
146
191
|
.highlight .sb {
|
147
192
|
color: #50a04f;
|
148
193
|
}
|
194
|
+
|
149
195
|
.highlight .sc {
|
150
196
|
color: #50a04f;
|
151
197
|
}
|
198
|
+
|
152
199
|
.highlight .sd {
|
153
200
|
color: #50a04f;
|
154
201
|
}
|
202
|
+
|
155
203
|
.highlight .s2 {
|
156
204
|
color: #50a04f;
|
157
205
|
}
|
206
|
+
|
158
207
|
.highlight .se {
|
159
208
|
color: #50a04f;
|
160
209
|
}
|
210
|
+
|
161
211
|
.highlight .sh {
|
162
212
|
color: #50a04f;
|
163
213
|
}
|
214
|
+
|
164
215
|
.highlight .si {
|
165
216
|
color: #50a04f;
|
166
217
|
}
|
218
|
+
|
167
219
|
.highlight .sx {
|
168
220
|
color: #50a04f;
|
169
221
|
}
|
222
|
+
|
170
223
|
.highlight .sr {
|
171
224
|
color: #0083bb;
|
172
225
|
}
|
226
|
+
|
173
227
|
.highlight .s1 {
|
174
228
|
color: #50a04f;
|
175
229
|
}
|
230
|
+
|
176
231
|
.highlight .ss {
|
177
232
|
color: #0083bb;
|
178
233
|
}
|
234
|
+
|
179
235
|
.highlight .bp {
|
180
236
|
color: #ca7601;
|
181
237
|
}
|
238
|
+
|
182
239
|
.highlight .vc {
|
183
240
|
color: #ca7601;
|
184
241
|
}
|
242
|
+
|
185
243
|
.highlight .vg {
|
186
244
|
color: #ca7601;
|
187
245
|
}
|
246
|
+
|
188
247
|
.highlight .vi {
|
189
248
|
color: #e35549;
|
190
249
|
}
|
250
|
+
|
191
251
|
.highlight .il {
|
192
252
|
color: #b66a00;
|
193
253
|
}
|
254
|
+
|
194
255
|
.highlight .gu {
|
195
256
|
color: #75715e;
|
196
257
|
}
|
258
|
+
|
197
259
|
.highlight .gd {
|
198
260
|
color: #e05151;
|
199
261
|
}
|
262
|
+
|
200
263
|
.highlight .gi {
|
201
264
|
color: #43d089;
|
202
265
|
}
|
266
|
+
|
203
267
|
.highlight .language-json .w + .s2 {
|
204
268
|
color: #e35549;
|
205
269
|
}
|
270
|
+
|
206
271
|
.highlight .language-json .kc {
|
207
272
|
color: #0083bb;
|
208
273
|
}
|
@@ -10,7 +10,7 @@
|
|
10
10
|
|
11
11
|
html {
|
12
12
|
line-height: 1.15; /* 1 */
|
13
|
-
|
13
|
+
text-size-adjust: 100%; /* 2 */
|
14
14
|
}
|
15
15
|
|
16
16
|
/* Sections
|
@@ -62,7 +62,7 @@ hr {
|
|
62
62
|
*/
|
63
63
|
|
64
64
|
pre {
|
65
|
-
font-family: monospace
|
65
|
+
font-family: monospace; /* 1 */
|
66
66
|
font-size: 1em; /* 2 */
|
67
67
|
}
|
68
68
|
|
@@ -105,7 +105,7 @@ strong {
|
|
105
105
|
code,
|
106
106
|
kbd,
|
107
107
|
samp {
|
108
|
-
font-family: monospace
|
108
|
+
font-family: monospace; /* 1 */
|
109
109
|
font-size: 1em; /* 2 */
|
110
110
|
}
|
111
111
|
|
@@ -198,7 +198,7 @@ button,
|
|
198
198
|
[type="button"],
|
199
199
|
[type="reset"],
|
200
200
|
[type="submit"] {
|
201
|
-
|
201
|
+
appearance: button;
|
202
202
|
}
|
203
203
|
|
204
204
|
/**
|
@@ -290,7 +290,7 @@ textarea {
|
|
290
290
|
*/
|
291
291
|
|
292
292
|
[type="search"] {
|
293
|
-
|
293
|
+
appearance: textfield; /* 1 */
|
294
294
|
outline-offset: -2px; /* 2 */
|
295
295
|
}
|
296
296
|
|
@@ -299,7 +299,7 @@ textarea {
|
|
299
299
|
*/
|
300
300
|
|
301
301
|
[type="search"]::-webkit-search-decoration {
|
302
|
-
|
302
|
+
appearance: none;
|
303
303
|
}
|
304
304
|
|
305
305
|
/**
|
@@ -308,7 +308,7 @@ textarea {
|
|
308
308
|
*/
|
309
309
|
|
310
310
|
::-webkit-file-upload-button {
|
311
|
-
|
311
|
+
appearance: button; /* 1 */
|
312
312
|
font: inherit; /* 2 */
|
313
313
|
}
|
314
314
|
|
data/assets/js/just-the-docs.js
CHANGED
@@ -556,12 +556,14 @@ function activateNav() {
|
|
556
556
|
// Document ready
|
557
557
|
|
558
558
|
jtd.onReady(function(){
|
559
|
-
|
559
|
+
if (document.getElementById('site-nav')) {
|
560
|
+
initNav();
|
561
|
+
activateNav();
|
562
|
+
scrollNav();
|
563
|
+
}
|
560
564
|
{%- if site.search_enabled != false %}
|
561
565
|
initSearch();
|
562
566
|
{%- endif %}
|
563
|
-
activateNav();
|
564
|
-
scrollNav();
|
565
567
|
});
|
566
568
|
|
567
569
|
// Copy button on code
|
data/lib/tasks/search.rake
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: just-the-docs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.10.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Patrick Marsceill
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2024-
|
12
|
+
date: 2024-09-09 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: bundler
|
@@ -100,7 +100,10 @@ files:
|
|
100
100
|
- _includes/components/footer.html
|
101
101
|
- _includes/components/header.html
|
102
102
|
- _includes/components/mermaid.html
|
103
|
-
- _includes/components/nav.html
|
103
|
+
- _includes/components/nav/children.html
|
104
|
+
- _includes/components/nav/links.html
|
105
|
+
- _includes/components/nav/pages.html
|
106
|
+
- _includes/components/nav/sorted.html
|
104
107
|
- _includes/components/search_footer.html
|
105
108
|
- _includes/components/search_header.html
|
106
109
|
- _includes/components/sidebar.html
|
@@ -129,7 +132,6 @@ files:
|
|
129
132
|
- _includes/mermaid_config.js
|
130
133
|
- _includes/nav_footer_custom.html
|
131
134
|
- _includes/search_placeholder_custom.html
|
132
|
-
- _includes/sorted_pages.html
|
133
135
|
- _includes/title.html
|
134
136
|
- _includes/toc_heading_custom.html
|
135
137
|
- _includes/vendor/anchor_headings.html
|
@@ -210,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
210
212
|
- !ruby/object:Gem::Version
|
211
213
|
version: '0'
|
212
214
|
requirements: []
|
213
|
-
rubygems_version: 3.
|
215
|
+
rubygems_version: 3.5.11
|
214
216
|
signing_key:
|
215
217
|
specification_version: 4
|
216
218
|
summary: A modern, highly customizable, and responsive Jekyll theme for documentation
|
@@ -1,75 +0,0 @@
|
|
1
|
-
{%- comment -%}
|
2
|
-
Include as: {%- include components/nav.html pages=pages -%}
|
3
|
-
Depends on: include.pages.
|
4
|
-
Results in: HTML for the navigation panel.
|
5
|
-
Includes:
|
6
|
-
sorted_pages.html
|
7
|
-
Overwrites:
|
8
|
-
nav_pages, first_level_pages, second_level_pages, third_level_pages,
|
9
|
-
node, children_list, child, grand_children_list, grand_child.
|
10
|
-
{%- endcomment -%}
|
11
|
-
|
12
|
-
{%- assign nav_pages = include.pages
|
13
|
-
| where_exp: "item", "item.title != nil"
|
14
|
-
| where_exp: "item", "item.nav_exclude != true" -%}
|
15
|
-
|
16
|
-
{%- include sorted_pages.html pages = nav_pages -%}
|
17
|
-
|
18
|
-
{%- comment -%}
|
19
|
-
It might be more efficient to sort the pages at each level separately.
|
20
|
-
{%- endcomment -%}
|
21
|
-
|
22
|
-
{%- assign first_level_pages = sorted_pages
|
23
|
-
| where_exp: "item", "item.parent == nil" -%}
|
24
|
-
{%- assign second_level_pages = sorted_pages
|
25
|
-
| where_exp: "item", "item.parent != nil"
|
26
|
-
| where_exp: "item", "item.grand_parent == nil" -%}
|
27
|
-
{%- assign third_level_pages = sorted_pages
|
28
|
-
| where_exp: "item", "item.grand_parent != nil" -%}
|
29
|
-
|
30
|
-
<ul class="nav-list">
|
31
|
-
{%- for node in first_level_pages -%}
|
32
|
-
<li class="nav-list-item">
|
33
|
-
{%- if node.has_children -%}
|
34
|
-
<button class="nav-list-expander btn-reset" aria-label="toggle items in {{ node.title }} category" aria-pressed="false">
|
35
|
-
<svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
|
36
|
-
</button>
|
37
|
-
{%- endif -%}
|
38
|
-
<a href="{{ node.url | relative_url }}" class="nav-list-link">{{ node.title }}</a>
|
39
|
-
{%- if node.has_children -%}
|
40
|
-
{%- assign children_list = second_level_pages
|
41
|
-
| where: "parent", node.title -%}
|
42
|
-
{%- if node.child_nav_order == 'desc' or node.child_nav_order == 'reversed' -%}
|
43
|
-
{%- assign children_list = children_list | reverse -%}
|
44
|
-
{%- endif -%}
|
45
|
-
<ul class="nav-list">
|
46
|
-
{%- for child in children_list -%}
|
47
|
-
<li class="nav-list-item">
|
48
|
-
{%- if child.has_children -%}
|
49
|
-
<button class="nav-list-expander btn-reset" aria-label="toggle items in {{ child.title }} category" aria-pressed="false">
|
50
|
-
<svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
|
51
|
-
</button>
|
52
|
-
{%- endif -%}
|
53
|
-
<a href="{{ child.url | relative_url }}" class="nav-list-link">{{ child.title }}</a>
|
54
|
-
{%- if child.has_children -%}
|
55
|
-
{%- assign grand_children_list = third_level_pages
|
56
|
-
| where: "parent", child.title
|
57
|
-
| where: "grand_parent", node.title -%}
|
58
|
-
{%- if child.child_nav_order == 'desc' or child.child_nav_order == 'reversed' -%}
|
59
|
-
{%- assign grand_children_list = grand_children_list | reverse -%}
|
60
|
-
{%- endif -%}
|
61
|
-
<ul class="nav-list">
|
62
|
-
{%- for grand_child in grand_children_list -%}
|
63
|
-
<li class="nav-list-item">
|
64
|
-
<a href="{{ grand_child.url | relative_url }}" class="nav-list-link">{{ grand_child.title }}</a>
|
65
|
-
</li>
|
66
|
-
{%- endfor -%}
|
67
|
-
</ul>
|
68
|
-
{%- endif -%}
|
69
|
-
</li>
|
70
|
-
{%- endfor -%}
|
71
|
-
</ul>
|
72
|
-
{%- endif -%}
|
73
|
-
</li>
|
74
|
-
{%- endfor -%}
|
75
|
-
</ul>
|