umbrel-docs 0.0.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (63) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE.txt +21 -0
  3. data/README.md +72 -0
  4. data/Rakefile +1 -0
  5. data/_includes/css/custom.scss.liquid +1 -0
  6. data/_includes/css/just-the-docs.scss.liquid +7 -0
  7. data/_includes/fix_linenos.html +65 -0
  8. data/_includes/footer_custom.html +3 -0
  9. data/_includes/head.html +28 -0
  10. data/_includes/head_custom.html +0 -0
  11. data/_includes/header_custom.html +0 -0
  12. data/_includes/js/custom.js +0 -0
  13. data/_includes/nav.html +100 -0
  14. data/_includes/title.html +5 -0
  15. data/_includes/vendor/anchor_headings.html +152 -0
  16. data/_layouts/about.html +5 -0
  17. data/_layouts/default.html +202 -0
  18. data/_layouts/home.html +5 -0
  19. data/_layouts/page.html +5 -0
  20. data/_layouts/post.html +5 -0
  21. data/_layouts/table_wrappers.html +7 -0
  22. data/_layouts/vendor/compress.html +10 -0
  23. data/_sass/base.scss +108 -0
  24. data/_sass/buttons.scss +118 -0
  25. data/_sass/code.scss +340 -0
  26. data/_sass/color_schemes/dark.scss +17 -0
  27. data/_sass/color_schemes/light.scss +0 -0
  28. data/_sass/content.scss +231 -0
  29. data/_sass/custom/custom.scss +0 -0
  30. data/_sass/labels.scss +37 -0
  31. data/_sass/layout.scss +205 -0
  32. data/_sass/modules.scss +20 -0
  33. data/_sass/navigation.scss +219 -0
  34. data/_sass/print.scss +40 -0
  35. data/_sass/search.scss +323 -0
  36. data/_sass/support/_functions.scss +9 -0
  37. data/_sass/support/_variables.scss +153 -0
  38. data/_sass/support/mixins/_buttons.scss +27 -0
  39. data/_sass/support/mixins/_layout.scss +34 -0
  40. data/_sass/support/mixins/_typography.scss +84 -0
  41. data/_sass/support/mixins/mixins.scss +3 -0
  42. data/_sass/support/support.scss +3 -0
  43. data/_sass/tables.scss +58 -0
  44. data/_sass/typography.scss +64 -0
  45. data/_sass/utilities/_colors.scss +239 -0
  46. data/_sass/utilities/_layout.scss +95 -0
  47. data/_sass/utilities/_lists.scss +17 -0
  48. data/_sass/utilities/_spacing.scss +165 -0
  49. data/_sass/utilities/_typography.scss +91 -0
  50. data/_sass/utilities/utilities.scss +5 -0
  51. data/_sass/vendor/normalize.scss/README.md +7 -0
  52. data/_sass/vendor/normalize.scss/normalize.scss +349 -0
  53. data/assets/css/just-the-docs-dark.scss +3 -0
  54. data/assets/css/just-the-docs-default.scss +8 -0
  55. data/assets/css/just-the-docs-light.scss +3 -0
  56. data/assets/images/just-the-docs.png +0 -0
  57. data/assets/images/search.svg +1 -0
  58. data/assets/js/just-the-docs.js +471 -0
  59. data/assets/js/vendor/lunr.min.js +6 -0
  60. data/assets/js/zzzz-search-data.json +72 -0
  61. data/bin/just-the-docs +16 -0
  62. data/lib/tasks/search.rake +86 -0
  63. metadata +182 -0
@@ -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
+ }
@@ -0,0 +1,323 @@
1
+ //
2
+ // Search input and autocomplete
3
+ //
4
+
5
+ .search {
6
+ position: relative;
7
+ z-index: 2;
8
+ flex-grow: 1;
9
+ height: $sp-10;
10
+ padding: $sp-2;
11
+ transition: padding linear #{$transition-duration / 2};
12
+
13
+ @include mq(md) {
14
+ position: relative !important;
15
+ width: auto !important;
16
+ height: 100% !important;
17
+ padding: 0;
18
+ transition: none;
19
+ }
20
+ }
21
+
22
+ .search-input-wrap {
23
+ position: relative;
24
+ z-index: 1;
25
+ height: $sp-8;
26
+ overflow: hidden;
27
+ border-radius: $border-radius;
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};
30
+
31
+ @include mq(md) {
32
+ position: absolute;
33
+ width: 100%;
34
+ max-width: $search-results-width;
35
+ height: 100% !important;
36
+ border-radius: 0;
37
+ box-shadow: none;
38
+ transition: width ease $transition-duration;
39
+ }
40
+ }
41
+
42
+ .search-input {
43
+ position: absolute;
44
+ width: 100%;
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;
51
+ background-color: $search-background-color;
52
+ border-top: 0;
53
+ border-right: 0;
54
+ border-bottom: 0;
55
+ border-left: 0;
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
+ }
66
+
67
+ &:focus {
68
+ outline: 0;
69
+
70
+ + .search-label .search-icon {
71
+ color: $link-color;
72
+ }
73
+ }
74
+ }
75
+
76
+ .search-label {
77
+ position: absolute;
78
+ display: flex;
79
+ height: 100%;
80
+ padding-left: $gutter-spacing-sm;
81
+
82
+ @include mq(md) {
83
+ padding-left: $gutter-spacing;
84
+ transition: padding-left linear #{$transition-duration / 2};
85
+ }
86
+
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
+ }
93
+ }
94
+
95
+ .search-results {
96
+ position: absolute;
97
+ left: 0;
98
+ display: none;
99
+ width: 100%;
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;
105
+ box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
106
+
107
+ @include mq(md) {
108
+ top: 100%;
109
+ width: $search-results-width;
110
+ max-height: calc(100vh - 200%) !important;
111
+ }
112
+ }
113
+
114
+ .search-results-list {
115
+ padding-left: 0;
116
+ margin-bottom: $sp-1;
117
+ list-style: none;
118
+ @include fs-4;
119
+
120
+ @include mq(md) {
121
+ @include fs-3;
122
+ }
123
+ }
124
+
125
+ .search-results-list-item {
126
+ padding: 0;
127
+ margin: 0;
128
+ }
129
+
130
+ .search-result {
131
+ display: block;
132
+ padding-top: $sp-1;
133
+ padding-right: $sp-3;
134
+ padding-bottom: $sp-1;
135
+ padding-left: $sp-3;
136
+
137
+ &:hover,
138
+ &.active {
139
+ background-color: $feedback-color;
140
+ }
141
+ }
142
+
143
+ .search-result-title {
144
+ display: block;
145
+ padding-top: $sp-2;
146
+ padding-bottom: $sp-2;
147
+
148
+ @include mq(sm) {
149
+ display: inline-block;
150
+ width: 40%;
151
+ padding-right: $sp-2;
152
+ vertical-align: top;
153
+ }
154
+ }
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
+
188
+ .search-result-rel-url {
189
+ display: block;
190
+ margin-left: #{$sp-4 + $sp-2};
191
+ overflow: hidden;
192
+ color: $search-result-preview-color;
193
+ text-overflow: ellipsis;
194
+ white-space: nowrap;
195
+ @include fs-1;
196
+ }
197
+
198
+ .search-result-previews {
199
+ display: block;
200
+ padding-top: $sp-2;
201
+ padding-bottom: $sp-2;
202
+ padding-left: $sp-4;
203
+ margin-left: $sp-2;
204
+ color: $search-result-preview-color;
205
+ word-wrap: break-word;
206
+ border-left: $border;
207
+ border-left-color: $border-color;
208
+ @include fs-2;
209
+
210
+ @include mq(sm) {
211
+ display: inline-block;
212
+ width: 60%;
213
+ padding-left: $sp-2;
214
+ margin-left: 0;
215
+ vertical-align: top;
216
+ }
217
+ }
218
+
219
+ .search-result-preview + .search-result-preview {
220
+ margin-top: $sp-1;
221
+ }
222
+
223
+ .search-result-highlight {
224
+ font-weight: bold;
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: 2.3rem;
288
+ }
289
+ }
290
+
291
+ .search-label {
292
+ @include mq(md) {
293
+ padding-left: 0.6rem;
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
+ }
323
+ }
@@ -0,0 +1,9 @@
1
+ @function rem($size, $unit: "") {
2
+ $remSize: $size / $root-font-size;
3
+
4
+ @if ($unit == false) {
5
+ @return #{$remSize};
6
+ } @else {
7
+ @return #{$remSize}rem;
8
+ }
9
+ }
@@ -0,0 +1,153 @@
1
+ //
2
+ // Typography
3
+ //
4
+
5
+ $body-font-family: system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI",
6
+ Roboto, "Helvetica Neue", Arial, sans-serif !default;
7
+ $mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace !default;
8
+ $root-font-size: 16px !default; // Base font-size for rems
9
+ $body-line-height: 1.4 !default;
10
+ $content-line-height: 1.6 !default;
11
+ $body-heading-line-height: 1.25 !default;
12
+
13
+ //
14
+ // Font size
15
+ // `-sm` suffix is the size at the small (and above) media query
16
+ //
17
+
18
+ $font-size-1: 9px !default;
19
+ $font-size-1-sm: 10px !default;
20
+ $font-size-2: 11px !default; //h4 - uppercased!, h6 not uppercased, text-small
21
+ $font-size-3: 12px !default; //h5
22
+ $font-size-4: 14px !default;
23
+ $font-size-5: 16px !default; //h3
24
+ $font-size-6: 18px !default; //h2
25
+ $font-size-7: 24px !default;
26
+ $font-size-8: 32px !default; //h1
27
+ $font-size-9: 36px !default;
28
+ $font-size-10: 42px !default;
29
+ $font-size-10-sm: 48px !default;
30
+
31
+ //
32
+ // Colors
33
+ //
34
+
35
+ $white: #fff !default;
36
+
37
+ $grey-dk-000: #959396 !default;
38
+ $grey-dk-100: #5c5962 !default;
39
+ $grey-dk-200: #44434d !default;
40
+ $grey-dk-250: #302d36 !default;
41
+ $grey-dk-300: #27262b !default;
42
+
43
+ $grey-lt-000: #f5f6fa !default;
44
+ $grey-lt-100: #eeebee !default;
45
+ $grey-lt-200: #ecebed !default;
46
+ $grey-lt-300: #e6e1e8 !default;
47
+
48
+ $purple-000: #7253ed !default;
49
+ $purple-100: #5e41d0 !default;
50
+ $purple-200: #4e26af !default;
51
+ $purple-300: #381885 !default;
52
+
53
+ $blue-000: #2c84fa !default;
54
+ $blue-100: #2869e6 !default;
55
+ $blue-200: #264caf !default;
56
+ $blue-300: #183385 !default;
57
+
58
+ $green-000: #41d693 !default;
59
+ $green-100: #11b584 !default;
60
+ $green-200: #009c7b !default;
61
+ $green-300: #026e57 !default;
62
+
63
+ $yellow-000: #ffeb82 !default;
64
+ $yellow-100: #fadf50 !default;
65
+ $yellow-200: #f7d12e !default;
66
+ $yellow-300: #e7af06 !default;
67
+
68
+ $red-000: #f77e7e !default;
69
+ $red-100: #f96e65 !default;
70
+ $red-200: #e94c4c !default;
71
+ $red-300: #dd2e2e !default;
72
+
73
+ $body-background-color: $white !default;
74
+ $sidebar-color: $grey-lt-000 !default;
75
+ $search-background-color: $white !default;
76
+ $table-background-color: $white !default;
77
+ $code-background-color: $grey-lt-000 !default;
78
+ $feedback-color: darken($sidebar-color, 3%) !default;
79
+
80
+ $body-text-color: $grey-dk-100 !default;
81
+ $body-heading-color: $grey-dk-300 !default;
82
+ $search-result-preview-color: $grey-dk-000 !default;
83
+ $nav-child-link-color: $grey-dk-100 !default;
84
+ $link-color: $purple-000 !default;
85
+ $btn-primary-color: $purple-100 !default;
86
+ $base-button-color: #f7f7f7 !default;
87
+
88
+ //
89
+ // Spacing
90
+ //
91
+
92
+ $spacing-unit: 1rem; // 1rem == 16px
93
+
94
+ $spacers: (
95
+ sp-0: 0,
96
+ sp-1: $spacing-unit * 0.25,
97
+ sp-2: $spacing-unit * 0.5,
98
+ sp-3: $spacing-unit * 0.75,
99
+ sp-4: $spacing-unit,
100
+ sp-5: $spacing-unit * 1.5,
101
+ sp-6: $spacing-unit * 2,
102
+ sp-7: $spacing-unit * 2.5,
103
+ sp-8: $spacing-unit * 3,
104
+ sp-9: $spacing-unit * 3.5,
105
+ sp-10: $spacing-unit * 4,
106
+ ) !default;
107
+
108
+ $sp-1: map-get($spacers, sp-1) !default; // 0.25 rem == 4px
109
+ $sp-2: map-get($spacers, sp-2) !default; // 0.5 rem == 8px
110
+ $sp-3: map-get($spacers, sp-3) !default; // 0.75 rem == 12px
111
+ $sp-4: map-get($spacers, sp-4) !default; // 1 rem == 16px
112
+ $sp-5: map-get($spacers, sp-5) !default; // 1.5 rem == 24px
113
+ $sp-6: map-get($spacers, sp-6) !default; // 2 rem == 32px
114
+ $sp-7: map-get($spacers, sp-7) !default; // 2.5 rem == 40px
115
+ $sp-8: map-get($spacers, sp-8) !default; // 3 rem == 48px
116
+ $sp-9: map-get($spacers, sp-9) !default; // 3.5 rem == 56px
117
+ $sp-10: map-get($spacers, sp-10) !default; // 4 rem == 64px
118
+
119
+ //
120
+ // Borders
121
+ //
122
+
123
+ $border: 1px solid !default;
124
+ $border-radius: 4px !default;
125
+ $border-color: $grey-lt-100 !default;
126
+
127
+ //
128
+ // Grid system
129
+ //
130
+
131
+ $gutter-spacing: $sp-6 !default;
132
+ $gutter-spacing-sm: $sp-4 !default;
133
+ $nav-width: 264px !default;
134
+ $nav-width-md: 248px !default;
135
+ $nav-list-item-height: $sp-6 !default;
136
+ $nav-list-item-height-sm: $sp-8 !default;
137
+ $nav-list-expander-right: true;
138
+ $content-width: 800px !default;
139
+ $header-height: 60px !default;
140
+ $search-results-width: $content-width - $nav-width !default;
141
+ $transition-duration: 400ms;
142
+
143
+ //
144
+ // Media queries in pixels
145
+ //
146
+
147
+ $media-queries: (
148
+ xs: 320px,
149
+ sm: 500px,
150
+ md: $content-width,
151
+ lg: $content-width + $nav-width,
152
+ xl: 1400px,
153
+ ) !default;