just-the-docs 0.2.6 → 0.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/_includes/css/custom.scss.liquid +1 -0
- data/_includes/css/just-the-docs.scss.liquid +7 -0
- data/_includes/head.html +4 -4
- data/_includes/nav.html +55 -40
- data/_includes/title.html +5 -1
- data/_includes/vendor/anchor_headings.html +2 -2
- data/_layouts/default.html +146 -73
- data/_layouts/table_wrappers.html +1 -1
- data/_sass/base.scss +16 -18
- data/_sass/code.scss +209 -71
- data/_sass/color_schemes/dark.scss +1 -1
- data/_sass/color_schemes/light.scss +0 -0
- data/_sass/content.scss +53 -5
- data/_sass/custom/custom.scss +0 -129
- data/_sass/labels.scss +5 -4
- data/_sass/layout.scss +67 -55
- data/_sass/modules.scss +20 -0
- data/_sass/navigation.scss +129 -53
- data/_sass/print.scss +40 -0
- data/_sass/search.scss +204 -48
- data/_sass/support/_functions.scss +2 -3
- data/_sass/support/_variables.scss +15 -9
- data/_sass/support/mixins/_layout.scss +1 -3
- data/_sass/support/mixins/_typography.scss +6 -1
- data/_sass/typography.scss +9 -7
- data/_sass/utilities/_layout.scss +74 -17
- data/_sass/utilities/_lists.scss +7 -1
- data/_sass/utilities/_spacing.scss +69 -25
- data/assets/css/just-the-docs-dark.scss +3 -0
- data/assets/css/just-the-docs-default.scss +8 -0
- data/assets/css/just-the-docs-light.scss +3 -0
- data/assets/js/just-the-docs.js +374 -197
- data/assets/js/zzzz-search-data.json +58 -0
- data/lib/tasks/search.rake +54 -9
- metadata +36 -24
- data/assets/css/dark-mode-preview.scss +0 -41
- data/assets/css/just-the-docs.scss +0 -44
- data/assets/js/search-data.json +0 -11
data/_sass/print.scss
ADDED
@@ -0,0 +1,40 @@
|
|
1
|
+
// stylelint-disable selector-max-specificity, selector-max-id, selector-max-type, selector-no-qualifying-type, primer/no-override,
|
2
|
+
|
3
|
+
@media print {
|
4
|
+
.site-footer,
|
5
|
+
.site-button,
|
6
|
+
#edit-this-page,
|
7
|
+
#back-to-top,
|
8
|
+
.site-nav,
|
9
|
+
.main-header {
|
10
|
+
display: none !important;
|
11
|
+
}
|
12
|
+
|
13
|
+
.side-bar {
|
14
|
+
width: 100%;
|
15
|
+
height: auto;
|
16
|
+
border-right: 0 !important;
|
17
|
+
}
|
18
|
+
|
19
|
+
.site-header {
|
20
|
+
border-bottom: 1px solid $border-color;
|
21
|
+
}
|
22
|
+
|
23
|
+
.site-title {
|
24
|
+
font-size: $root-font-size !important;
|
25
|
+
font-weight: 700 !important;
|
26
|
+
}
|
27
|
+
|
28
|
+
.text-small {
|
29
|
+
font-size: 8pt !important;
|
30
|
+
}
|
31
|
+
|
32
|
+
pre.highlight {
|
33
|
+
border: 1px solid $border-color;
|
34
|
+
}
|
35
|
+
|
36
|
+
.main {
|
37
|
+
max-width: none;
|
38
|
+
margin-left: 0;
|
39
|
+
}
|
40
|
+
}
|
data/_sass/search.scss
CHANGED
@@ -4,91 +4,115 @@
|
|
4
4
|
|
5
5
|
.search {
|
6
6
|
position: relative;
|
7
|
-
z-index:
|
7
|
+
z-index: 2;
|
8
8
|
flex-grow: 1;
|
9
|
-
height:
|
10
|
-
|
9
|
+
height: $sp-10;
|
10
|
+
padding: $sp-2;
|
11
|
+
transition: padding linear #{$transition-duration / 2};
|
11
12
|
|
12
13
|
@include mq(md) {
|
13
|
-
|
14
|
+
position: relative !important;
|
15
|
+
width: auto !important;
|
16
|
+
height: 100% !important;
|
17
|
+
padding: 0;
|
18
|
+
transition: none;
|
14
19
|
}
|
15
20
|
}
|
16
21
|
|
17
22
|
.search-input-wrap {
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
23
|
+
position: relative;
|
24
|
+
z-index: 1;
|
25
|
+
height: $sp-8;
|
26
|
+
overflow: hidden;
|
22
27
|
border-radius: $border-radius;
|
23
28
|
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
29
|
+
transition: height linear #{$transition-duration / 2};
|
24
30
|
|
25
31
|
@include mq(md) {
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
background-color: $body-background-color;
|
32
|
+
position: absolute;
|
33
|
+
width: 100%;
|
34
|
+
max-width: $search-results-width;
|
35
|
+
height: 100% !important;
|
31
36
|
border-radius: 0;
|
32
37
|
box-shadow: none;
|
38
|
+
transition: width ease $transition-duration;
|
33
39
|
}
|
34
40
|
}
|
35
41
|
|
36
42
|
.search-input {
|
37
|
-
|
43
|
+
position: absolute;
|
38
44
|
width: 100%;
|
39
|
-
|
40
|
-
padding-
|
45
|
+
height: 100%;
|
46
|
+
padding-top: $sp-2;
|
47
|
+
padding-right: $gutter-spacing-sm;
|
48
|
+
padding-bottom: $sp-2;
|
49
|
+
padding-left: #{$gutter-spacing-sm + $sp-5};
|
50
|
+
font-size: 16px;
|
41
51
|
background-color: $search-background-color;
|
42
52
|
border-top: 0;
|
43
53
|
border-right: 0;
|
44
54
|
border-bottom: 0;
|
45
55
|
border-left: 0;
|
46
|
-
|
47
|
-
|
56
|
+
border-radius: 0;
|
57
|
+
|
58
|
+
@include mq(md) {
|
59
|
+
padding-top: $gutter-spacing-sm;
|
60
|
+
padding-bottom: $gutter-spacing-sm;
|
61
|
+
padding-left: #{$gutter-spacing + $sp-5};
|
62
|
+
font-size: 14px;
|
63
|
+
background-color: $body-background-color;
|
64
|
+
transition: padding-left linear #{$transition-duration / 2};
|
65
|
+
}
|
48
66
|
|
49
67
|
&:focus {
|
50
68
|
outline: 0;
|
51
|
-
box-shadow: none;
|
52
69
|
|
53
|
-
+ .search-icon {
|
54
|
-
|
70
|
+
+ .search-label .search-icon {
|
71
|
+
color: $link-color;
|
55
72
|
}
|
56
73
|
}
|
74
|
+
}
|
75
|
+
|
76
|
+
.search-label {
|
77
|
+
position: absolute;
|
78
|
+
display: flex;
|
79
|
+
height: 100%;
|
80
|
+
padding-left: $gutter-spacing-sm;
|
57
81
|
|
58
82
|
@include mq(md) {
|
59
|
-
|
60
|
-
|
83
|
+
padding-left: $gutter-spacing;
|
84
|
+
transition: padding-left linear #{$transition-duration / 2};
|
61
85
|
}
|
62
|
-
}
|
63
86
|
|
64
|
-
.search-icon {
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
87
|
+
.search-icon {
|
88
|
+
width: #{$sp-4 * 1.2};
|
89
|
+
height: #{$sp-4 * 1.2};
|
90
|
+
align-self: center;
|
91
|
+
color: $grey-dk-000;
|
92
|
+
}
|
69
93
|
}
|
70
94
|
|
71
|
-
.search-results
|
95
|
+
.search-results {
|
72
96
|
position: absolute;
|
73
|
-
|
97
|
+
left: 0;
|
74
98
|
display: none;
|
75
99
|
width: 100%;
|
76
|
-
|
77
|
-
|
100
|
+
max-height: calc(100% - #{$sp-10});
|
101
|
+
overflow-y: auto;
|
102
|
+
background-color: $search-background-color;
|
103
|
+
border-bottom-right-radius: $border-radius;
|
104
|
+
border-bottom-left-radius: $border-radius;
|
78
105
|
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
79
106
|
|
80
|
-
&.active {
|
81
|
-
display: block;
|
82
|
-
}
|
83
|
-
|
84
107
|
@include mq(md) {
|
108
|
+
top: 100%;
|
85
109
|
width: $search-results-width;
|
110
|
+
max-height: calc(100vh - 200%) !important;
|
86
111
|
}
|
87
112
|
}
|
88
113
|
|
89
114
|
.search-results-list {
|
90
115
|
padding-left: 0;
|
91
|
-
margin-top: $sp-1;
|
92
116
|
margin-bottom: $sp-1;
|
93
117
|
list-style: none;
|
94
118
|
@include fs-4;
|
@@ -112,31 +136,58 @@
|
|
112
136
|
|
113
137
|
&:hover,
|
114
138
|
&.active {
|
115
|
-
background-color: $
|
116
|
-
}
|
117
|
-
|
118
|
-
@include mq(md) {
|
119
|
-
padding-right: $sp-4;
|
120
|
-
padding-left: $sp-4;
|
139
|
+
background-color: $feedback-color;
|
121
140
|
}
|
122
141
|
}
|
123
142
|
|
124
143
|
.search-result-title {
|
125
144
|
display: block;
|
126
145
|
padding-top: $sp-2;
|
127
|
-
padding-right: $sp-4;
|
128
146
|
padding-bottom: $sp-2;
|
129
147
|
|
130
148
|
@include mq(sm) {
|
131
149
|
display: inline-block;
|
132
150
|
width: 40%;
|
133
|
-
|
151
|
+
padding-right: $sp-2;
|
134
152
|
vertical-align: top;
|
135
153
|
}
|
136
154
|
}
|
137
155
|
|
156
|
+
.search-result-doc {
|
157
|
+
display: flex;
|
158
|
+
align-items: center;
|
159
|
+
word-wrap: break-word;
|
160
|
+
|
161
|
+
&.search-result-doc-parent {
|
162
|
+
opacity: 0.5;
|
163
|
+
@include fs-3;
|
164
|
+
|
165
|
+
@include mq(md) {
|
166
|
+
@include fs-2;
|
167
|
+
}
|
168
|
+
}
|
169
|
+
|
170
|
+
.search-result-icon {
|
171
|
+
width: $sp-4;
|
172
|
+
height: $sp-4;
|
173
|
+
margin-right: $sp-2;
|
174
|
+
color: $link-color;
|
175
|
+
flex-shrink: 0;
|
176
|
+
}
|
177
|
+
|
178
|
+
.search-result-doc-title {
|
179
|
+
overflow: auto;
|
180
|
+
}
|
181
|
+
}
|
182
|
+
|
183
|
+
.search-result-section {
|
184
|
+
margin-left: #{$sp-4 + $sp-2};
|
185
|
+
word-wrap: break-word;
|
186
|
+
}
|
187
|
+
|
138
188
|
.search-result-rel-url {
|
139
189
|
display: block;
|
190
|
+
margin-left: #{$sp-4 + $sp-2};
|
140
191
|
overflow: hidden;
|
141
192
|
color: $search-result-preview-color;
|
142
193
|
text-overflow: ellipsis;
|
@@ -144,12 +195,14 @@
|
|
144
195
|
@include fs-1;
|
145
196
|
}
|
146
197
|
|
147
|
-
.search-result-
|
198
|
+
.search-result-previews {
|
148
199
|
display: block;
|
149
200
|
padding-top: $sp-2;
|
150
201
|
padding-bottom: $sp-2;
|
151
202
|
padding-left: $sp-4;
|
203
|
+
margin-left: $sp-2;
|
152
204
|
color: $search-result-preview-color;
|
205
|
+
word-wrap: break-word;
|
153
206
|
border-left: $border;
|
154
207
|
border-left-color: $border-color;
|
155
208
|
@include fs-2;
|
@@ -157,11 +210,114 @@
|
|
157
210
|
@include mq(sm) {
|
158
211
|
display: inline-block;
|
159
212
|
width: 60%;
|
213
|
+
padding-left: $sp-2;
|
214
|
+
margin-left: 0;
|
160
215
|
vertical-align: top;
|
161
216
|
}
|
162
217
|
}
|
163
218
|
|
219
|
+
.search-result-preview + .search-result-preview {
|
220
|
+
margin-top: $sp-1;
|
221
|
+
}
|
222
|
+
|
164
223
|
.search-result-highlight {
|
165
224
|
font-weight: bold;
|
166
|
-
|
225
|
+
}
|
226
|
+
|
227
|
+
.search-no-result {
|
228
|
+
padding-top: $sp-2;
|
229
|
+
padding-right: $sp-3;
|
230
|
+
padding-bottom: $sp-2;
|
231
|
+
padding-left: $sp-3;
|
232
|
+
@include fs-3;
|
233
|
+
}
|
234
|
+
|
235
|
+
.search-button {
|
236
|
+
position: fixed;
|
237
|
+
right: $sp-4;
|
238
|
+
bottom: $sp-4;
|
239
|
+
display: flex;
|
240
|
+
width: $sp-9;
|
241
|
+
height: $sp-9;
|
242
|
+
background-color: $search-background-color;
|
243
|
+
border: 1px solid rgba($link-color, 0.3);
|
244
|
+
border-radius: #{$sp-9 / 2};
|
245
|
+
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
246
|
+
align-items: center;
|
247
|
+
justify-content: center;
|
248
|
+
}
|
249
|
+
|
250
|
+
.search-overlay {
|
251
|
+
position: fixed;
|
252
|
+
top: 0;
|
253
|
+
left: 0;
|
254
|
+
z-index: 1;
|
255
|
+
width: 0;
|
256
|
+
height: 0;
|
257
|
+
background-color: rgba(0, 0, 0, 0.3);
|
258
|
+
opacity: 0;
|
259
|
+
transition: opacity ease $transition-duration, width 0s $transition-duration,
|
260
|
+
height 0s $transition-duration;
|
261
|
+
}
|
262
|
+
|
263
|
+
.search-active {
|
264
|
+
.search {
|
265
|
+
position: fixed;
|
266
|
+
top: 0;
|
267
|
+
left: 0;
|
268
|
+
width: 100%;
|
269
|
+
height: 100%;
|
270
|
+
padding: 0;
|
271
|
+
}
|
272
|
+
|
273
|
+
.search-input-wrap {
|
274
|
+
height: $sp-10;
|
275
|
+
border-radius: 0;
|
276
|
+
|
277
|
+
@include mq(md) {
|
278
|
+
width: $search-results-width;
|
279
|
+
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
280
|
+
}
|
281
|
+
}
|
282
|
+
|
283
|
+
.search-input {
|
284
|
+
background-color: $search-background-color;
|
285
|
+
|
286
|
+
@include mq(md) {
|
287
|
+
padding-left: #{$sp-4 * 1.25 + $sp-5};
|
288
|
+
}
|
289
|
+
}
|
290
|
+
|
291
|
+
.search-label {
|
292
|
+
@include mq(md) {
|
293
|
+
padding-left: #{$sp-4 * 1.25};
|
294
|
+
}
|
295
|
+
}
|
296
|
+
|
297
|
+
.search-results {
|
298
|
+
display: block;
|
299
|
+
}
|
300
|
+
|
301
|
+
.search-overlay {
|
302
|
+
width: 100%;
|
303
|
+
height: 100%;
|
304
|
+
opacity: 1;
|
305
|
+
transition: opacity ease $transition-duration, width 0s, height 0s;
|
306
|
+
}
|
307
|
+
|
308
|
+
@include mq(md) {
|
309
|
+
.main {
|
310
|
+
position: fixed;
|
311
|
+
right: 0;
|
312
|
+
left: 0;
|
313
|
+
}
|
314
|
+
}
|
315
|
+
|
316
|
+
.main-header {
|
317
|
+
padding-top: $sp-10;
|
318
|
+
|
319
|
+
@include mq(md) {
|
320
|
+
padding-top: 0;
|
321
|
+
}
|
322
|
+
}
|
167
323
|
}
|
@@ -2,12 +2,13 @@
|
|
2
2
|
// Typography
|
3
3
|
//
|
4
4
|
|
5
|
-
$body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue",
|
5
|
+
$body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue",
|
6
|
+
helvetica, roboto, noto, "segoe ui", arial, sans-serif !default;
|
6
7
|
$mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace !default;
|
7
|
-
$root-font-size: 16px !default;
|
8
|
+
$root-font-size: 16px !default; // Base font-size for rems
|
8
9
|
$body-line-height: 1.4 !default;
|
9
|
-
$content-line-height: 1.
|
10
|
-
$body-heading-line-height: 1.
|
10
|
+
$content-line-height: 1.6 !default;
|
11
|
+
$body-heading-line-height: 1.25 !default;
|
11
12
|
|
12
13
|
//
|
13
14
|
// Colors
|
@@ -56,6 +57,7 @@ $sidebar-color: $grey-lt-000 !default;
|
|
56
57
|
$search-background-color: $white !default;
|
57
58
|
$table-background-color: $white !default;
|
58
59
|
$code-background-color: $grey-lt-000 !default;
|
60
|
+
$feedback-color: darken($sidebar-color, 3%) !default;
|
59
61
|
|
60
62
|
$body-text-color: $grey-dk-100 !default;
|
61
63
|
$body-heading-color: $grey-dk-300 !default;
|
@@ -82,7 +84,7 @@ $spacers: (
|
|
82
84
|
sp-7: $spacing-unit * 2.5,
|
83
85
|
sp-8: $spacing-unit * 3,
|
84
86
|
sp-9: $spacing-unit * 3.5,
|
85
|
-
sp-10: $spacing-unit * 4
|
87
|
+
sp-10: $spacing-unit * 4,
|
86
88
|
) !default;
|
87
89
|
|
88
90
|
$sp-1: map-get($spacers, sp-1) !default; // 0.25 rem == 4px
|
@@ -93,8 +95,8 @@ $sp-5: map-get($spacers, sp-5) !default; // 1.5 rem == 24px
|
|
93
95
|
$sp-6: map-get($spacers, sp-6) !default; // 2 rem == 32px
|
94
96
|
$sp-7: map-get($spacers, sp-7) !default; // 2.5 rem == 40px
|
95
97
|
$sp-8: map-get($spacers, sp-8) !default; // 3 rem == 48px
|
96
|
-
$sp-9: map-get($spacers, sp-9) !default; //
|
97
|
-
$sp-10: map-get($spacers, sp-10) !default; // 4
|
98
|
+
$sp-9: map-get($spacers, sp-9) !default; // 3.5 rem == 56px
|
99
|
+
$sp-10: map-get($spacers, sp-10) !default; // 4 rem == 64px
|
98
100
|
|
99
101
|
//
|
100
102
|
// Borders
|
@@ -112,9 +114,13 @@ $gutter-spacing: $sp-6 !default;
|
|
112
114
|
$gutter-spacing-sm: $sp-4 !default;
|
113
115
|
$nav-width: 264px !default;
|
114
116
|
$nav-width-md: 248px !default;
|
117
|
+
$nav-list-item-height: $sp-6 !default;
|
118
|
+
$nav-list-item-height-sm: $sp-8 !default;
|
119
|
+
$nav-list-expander-right: true;
|
115
120
|
$content-width: 800px !default;
|
116
121
|
$header-height: 60px !default;
|
117
|
-
$search-results-width:
|
122
|
+
$search-results-width: $content-width - $nav-width !default;
|
123
|
+
$transition-duration: 400ms;
|
118
124
|
|
119
125
|
//
|
120
126
|
// Media queries in pixels
|
@@ -125,5 +131,5 @@ $media-queries: (
|
|
125
131
|
sm: 500px,
|
126
132
|
md: $content-width,
|
127
133
|
lg: $content-width + $nav-width,
|
128
|
-
xl: 1400px
|
134
|
+
xl: 1400px,
|
129
135
|
) !default;
|