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,340 @@
1
+ //
2
+ // Code and syntax highlighting
3
+ //
4
+ // stylelint-disable selector-no-qualifying-type, declaration-block-semicolon-newline-after,declaration-block-single-line-max-declarations, selector-no-type, selector-max-type
5
+
6
+ code {
7
+ padding: 0.2em 0.15em;
8
+ font-weight: 400;
9
+ background-color: $code-background-color;
10
+ border: $border $border-color;
11
+ border-radius: $border-radius;
12
+ }
13
+
14
+ // Avoid appearance of dark border around visited code links in Safari
15
+ a:visited code {
16
+ border-color: $border-color;
17
+ }
18
+
19
+ // Content structure for highlighted code blocks using fences or Liquid
20
+ //
21
+ // ```[LANG]...```, no kramdown line_numbers:
22
+ // div.[language-LANG.]highlighter-rouge > div.highlight > pre.highlight > code
23
+ //
24
+ // ```[LANG]...```, kramdown line_numbers = true:
25
+ // div.[language-LANG.]highlighter-rouge > div.highlight > pre.highlight > code
26
+ // > div.table-wrapper > table.rouge-table > tbody > tr
27
+ // > td.rouge-gutter.gl > pre.lineno
28
+ // | td.rouge-code > pre
29
+ //
30
+ // {% highlight LANG %}...{% endhighlight %}:
31
+ // figure.highlight > pre > code.language-LANG
32
+ //
33
+ // {% highlight LANG linenos %}...{% endhighlight %}:
34
+ // figure.highlight > pre > code.language-LANG
35
+ // > div.table-wrapper > table.rouge-table > tbody > tr
36
+ // > td.gutter.gl > pre.lineno
37
+ // | td.code > pre
38
+ //
39
+ // fix_linenos removes the outermost pre when it encloses table.rouge-table
40
+ //
41
+ // See docs/index-test.md for some tests.
42
+ //
43
+ // No kramdown line_numbers: fences and Liquid highlighting look the same.
44
+ // Kramdown line_numbers = true: fences have a wider gutter than with Liquid?
45
+
46
+ // ```[LANG]...```
47
+ div.highlighter-rouge {
48
+ padding: $sp-3;
49
+ margin-top: 0;
50
+ margin-bottom: $sp-3;
51
+ overflow-x: auto;
52
+ background-color: $code-background-color;
53
+ border-radius: $border-radius;
54
+ box-shadow: none;
55
+ -webkit-overflow-scrolling: touch;
56
+
57
+ div.highlight,
58
+ pre.highlight,
59
+ code {
60
+ padding: 0;
61
+ margin: 0;
62
+ border: 0;
63
+ }
64
+ }
65
+
66
+ // {% highlight LANG %}...{% endhighlight %},
67
+ // {% highlight LANG linenos %}...{% endhighlight %}:
68
+ figure.highlight {
69
+ padding: $sp-3;
70
+ margin-top: 0;
71
+ margin-bottom: $sp-3;
72
+ background-color: $code-background-color;
73
+ border-radius: $border-radius;
74
+ box-shadow: none;
75
+ -webkit-overflow-scrolling: touch;
76
+
77
+ pre,
78
+ code {
79
+ padding: 0;
80
+ margin: 0;
81
+ border: 0;
82
+ }
83
+ }
84
+
85
+ // ```[LANG]...```, kramdown line_numbers = true,
86
+ // {% highlight LANG linenos %}...{% endhighlight %}:
87
+ .highlight .table-wrapper {
88
+ padding: 0;
89
+ margin: 0;
90
+ border: 0;
91
+ box-shadow: none;
92
+
93
+ td,
94
+ pre {
95
+ @include fs-2;
96
+ min-width: 0;
97
+ padding: 0;
98
+ background-color: $code-background-color;
99
+ border: 0;
100
+ }
101
+
102
+ td.gl {
103
+ padding-right: $sp-3;
104
+ }
105
+
106
+ pre {
107
+ margin: 0;
108
+ line-height: 2;
109
+ }
110
+ }
111
+
112
+ .highlight .c {
113
+ color: #586e75;
114
+ } // comment //
115
+ .highlight .err {
116
+ color: #93a1a1;
117
+ } // error //
118
+ .highlight .g {
119
+ color: #93a1a1;
120
+ } // generic //
121
+ .highlight .k {
122
+ color: #859900;
123
+ } // keyword //
124
+ .highlight .l {
125
+ color: #93a1a1;
126
+ } // literal //
127
+ .highlight .n {
128
+ color: #93a1a1;
129
+ } // name //
130
+ .highlight .o {
131
+ color: #859900;
132
+ } // operator //
133
+ .highlight .x {
134
+ color: #cb4b16;
135
+ } // other //
136
+ .highlight .p {
137
+ color: #93a1a1;
138
+ } // punctuation //
139
+ .highlight .cm {
140
+ color: #586e75;
141
+ } // comment.multiline //
142
+ .highlight .cp {
143
+ color: #859900;
144
+ } // comment.preproc //
145
+ .highlight .c1 {
146
+ color: #586e75;
147
+ } // comment.single //
148
+ .highlight .cs {
149
+ color: #859900;
150
+ } // comment.special //
151
+ .highlight .gd {
152
+ color: #2aa198;
153
+ } // generic.deleted //
154
+ .highlight .ge {
155
+ font-style: italic;
156
+ color: #93a1a1;
157
+ } // generic.emph //
158
+ .highlight .gr {
159
+ color: #dc322f;
160
+ } // generic.error //
161
+ .highlight .gh {
162
+ color: #cb4b16;
163
+ } // generic.heading //
164
+ .highlight .gi {
165
+ color: #859900;
166
+ } // generic.inserted //
167
+ .highlight .go {
168
+ color: #93a1a1;
169
+ } // generic.output //
170
+ .highlight .gp {
171
+ color: #93a1a1;
172
+ } // generic.prompt //
173
+ .highlight .gs {
174
+ font-weight: bold;
175
+ color: #93a1a1;
176
+ } // generic.strong //
177
+ .highlight .gu {
178
+ color: #cb4b16;
179
+ } // generic.subheading //
180
+ .highlight .gt {
181
+ color: #93a1a1;
182
+ } // generic.traceback //
183
+ .highlight .kc {
184
+ color: #cb4b16;
185
+ } // keyword.constant //
186
+ .highlight .kd {
187
+ color: #268bd2;
188
+ } // keyword.declaration //
189
+ .highlight .kn {
190
+ color: #859900;
191
+ } // keyword.namespace //
192
+ .highlight .kp {
193
+ color: #859900;
194
+ } // keyword.pseudo //
195
+ .highlight .kr {
196
+ color: #268bd2;
197
+ } // keyword.reserved //
198
+ .highlight .kt {
199
+ color: #dc322f;
200
+ } // keyword.type //
201
+ .highlight .ld {
202
+ color: #93a1a1;
203
+ } // literal.date //
204
+ .highlight .m {
205
+ color: #2aa198;
206
+ } // literal.number //
207
+ .highlight .s {
208
+ color: #2aa198;
209
+ } // literal.string //
210
+ .highlight .na {
211
+ color: #555;
212
+ } // name.attribute //
213
+ .highlight .nb {
214
+ color: #b58900;
215
+ } // name.builtin //
216
+ .highlight .nc {
217
+ color: #268bd2;
218
+ } // name.class //
219
+ .highlight .no {
220
+ color: #cb4b16;
221
+ } // name.constant //
222
+ .highlight .nd {
223
+ color: #268bd2;
224
+ } // name.decorator //
225
+ .highlight .ni {
226
+ color: #cb4b16;
227
+ } // name.entity //
228
+ .highlight .ne {
229
+ color: #cb4b16;
230
+ } // name.exception //
231
+ .highlight .nf {
232
+ color: #268bd2;
233
+ } // name.function //
234
+ .highlight .nl {
235
+ color: #555;
236
+ } // name.label //
237
+ .highlight .nn {
238
+ color: #93a1a1;
239
+ } // name.namespace //
240
+ .highlight .nx {
241
+ color: #555;
242
+ } // name.other //
243
+ .highlight .py {
244
+ color: #93a1a1;
245
+ } // name.property //
246
+ .highlight .nt {
247
+ color: #268bd2;
248
+ } // name.tag //
249
+ .highlight .nv {
250
+ color: #268bd2;
251
+ } // name.variable //
252
+ .highlight .ow {
253
+ color: #859900;
254
+ } // operator.word //
255
+ .highlight .w {
256
+ color: #93a1a1;
257
+ } // text.whitespace //
258
+ .highlight .mf {
259
+ color: #2aa198;
260
+ } // literal.number.float //
261
+ .highlight .mh {
262
+ color: #2aa198;
263
+ } // literal.number.hex //
264
+ .highlight .mi {
265
+ color: #2aa198;
266
+ } // literal.number.integer //
267
+ .highlight .mo {
268
+ color: #2aa198;
269
+ } // literal.number.oct //
270
+ .highlight .sb {
271
+ color: #586e75;
272
+ } // literal.string.backtick //
273
+ .highlight .sc {
274
+ color: #2aa198;
275
+ } // literal.string.char //
276
+ .highlight .sd {
277
+ color: #93a1a1;
278
+ } // literal.string.doc //
279
+ .highlight .s2 {
280
+ color: #2aa198;
281
+ } // literal.string.double //
282
+ .highlight .se {
283
+ color: #cb4b16;
284
+ } // literal.string.escape //
285
+ .highlight .sh {
286
+ color: #93a1a1;
287
+ } // literal.string.heredoc //
288
+ .highlight .si {
289
+ color: #2aa198;
290
+ } // literal.string.interpol //
291
+ .highlight .sx {
292
+ color: #2aa198;
293
+ } // literal.string.other //
294
+ .highlight .sr {
295
+ color: #dc322f;
296
+ } // literal.string.regex //
297
+ .highlight .s1 {
298
+ color: #2aa198;
299
+ } // literal.string.single //
300
+ .highlight .ss {
301
+ color: #2aa198;
302
+ } // literal.string.symbol //
303
+ .highlight .bp {
304
+ color: #268bd2;
305
+ } // name.builtin.pseudo //
306
+ .highlight .vc {
307
+ color: #268bd2;
308
+ } // name.variable.class //
309
+ .highlight .vg {
310
+ color: #268bd2;
311
+ } // name.variable.global //
312
+ .highlight .vi {
313
+ color: #268bd2;
314
+ } // name.variable.instance //
315
+ .highlight .il {
316
+ color: #2aa198;
317
+ } // literal.number.integer.long //
318
+
319
+ //
320
+ // Code examples (rendered)
321
+ //
322
+
323
+ .code-example {
324
+ padding: $sp-3;
325
+ margin-bottom: $sp-3;
326
+ overflow: auto;
327
+ border: 1px solid $border-color;
328
+ border-radius: $border-radius;
329
+
330
+ + .highlighter-rouge,
331
+ + figure.highlight {
332
+ position: relative;
333
+ margin-top: -$sp-4;
334
+ border-right: 1px solid $border-color;
335
+ border-bottom: 1px solid $border-color;
336
+ border-left: 1px solid $border-color;
337
+ border-top-left-radius: 0;
338
+ border-top-right-radius: 0;
339
+ }
340
+ }
@@ -0,0 +1,17 @@
1
+ $body-background-color: $grey-dk-300;
2
+ $sidebar-color: $grey-dk-300;
3
+ $border-color: $grey-dk-200;
4
+
5
+ $body-text-color: $grey-lt-300;
6
+ $body-heading-color: $grey-lt-000;
7
+ $nav-child-link-color: $grey-dk-000;
8
+ $search-result-preview-color: $grey-dk-000;
9
+
10
+ $link-color: $blue-000;
11
+ $btn-primary-color: $blue-200;
12
+ $base-button-color: $grey-dk-250;
13
+
14
+ $code-background-color: $grey-dk-250;
15
+ $search-background-color: $grey-dk-250;
16
+ $table-background-color: $grey-dk-250;
17
+ $feedback-color: darken($sidebar-color, 3%);
File without changes
@@ -0,0 +1,231 @@
1
+ @charset "UTF-8";
2
+
3
+ //
4
+ // Styles for rendered markdown in the .main-content container
5
+ //
6
+ // stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type
7
+
8
+ .main-content {
9
+ line-height: $content-line-height;
10
+
11
+ ol,
12
+ ul,
13
+ dl,
14
+ pre,
15
+ address,
16
+ blockquote,
17
+ .table-wrapper {
18
+ margin-top: 0.5em;
19
+ }
20
+
21
+ a {
22
+ overflow: hidden;
23
+ text-overflow: ellipsis;
24
+ white-space: nowrap;
25
+ }
26
+
27
+ ul,
28
+ ol {
29
+ padding-left: 1.5em;
30
+ }
31
+
32
+ li {
33
+ .highlight {
34
+ margin-top: $sp-1;
35
+ }
36
+ }
37
+
38
+ ol {
39
+ list-style-type: none;
40
+ counter-reset: step-counter;
41
+
42
+ > li {
43
+ position: relative;
44
+
45
+ &::before {
46
+ position: absolute;
47
+ top: 0.2em;
48
+ left: -1.6em;
49
+ color: $grey-dk-000;
50
+ content: counter(step-counter);
51
+ counter-increment: step-counter;
52
+ @include fs-3;
53
+
54
+ @include mq(sm) {
55
+ top: 0.11em;
56
+ }
57
+ }
58
+
59
+ ol {
60
+ counter-reset: sub-counter;
61
+
62
+ li {
63
+ &::before {
64
+ content: counter(sub-counter, lower-alpha);
65
+ counter-increment: sub-counter;
66
+ }
67
+ }
68
+ }
69
+ }
70
+ }
71
+
72
+ ul {
73
+ list-style: none;
74
+
75
+ > li {
76
+ &::before {
77
+ position: absolute;
78
+ margin-left: -1.4em;
79
+ color: $grey-dk-000;
80
+ content: "•";
81
+ }
82
+ }
83
+ }
84
+
85
+ .task-list {
86
+ padding-left: 0;
87
+ }
88
+
89
+ .task-list-item {
90
+ display: flex;
91
+ align-items: center;
92
+
93
+ &::before {
94
+ content: "";
95
+ }
96
+ }
97
+
98
+ .task-list-item-checkbox {
99
+ margin-right: 0.6em;
100
+ }
101
+
102
+ hr + * {
103
+ margin-top: 0;
104
+ }
105
+
106
+ h1:first-of-type {
107
+ margin-top: 0.5em;
108
+ }
109
+
110
+ dl {
111
+ display: grid;
112
+ grid-template: auto / 10em 1fr;
113
+ }
114
+
115
+ dt,
116
+ dd {
117
+ margin: 0.25em 0;
118
+ }
119
+
120
+ dt {
121
+ grid-column: 1;
122
+ font-weight: 500;
123
+ text-align: right;
124
+ &::after {
125
+ content: ":";
126
+ }
127
+ }
128
+
129
+ dd {
130
+ grid-column: 2;
131
+ margin-bottom: 0;
132
+ margin-left: 1em;
133
+ blockquote,
134
+ div,
135
+ dl,
136
+ dt,
137
+ h1,
138
+ h2,
139
+ h3,
140
+ h4,
141
+ h5,
142
+ h6,
143
+ li,
144
+ ol,
145
+ p,
146
+ pre,
147
+ table,
148
+ ul,
149
+ .table-wrapper {
150
+ &:first-child {
151
+ margin-top: 0;
152
+ }
153
+ }
154
+ }
155
+
156
+ dd,
157
+ ol,
158
+ ul {
159
+ dl:first-child {
160
+ dt:first-child,
161
+ dd:nth-child(2) {
162
+ margin-top: 0;
163
+ }
164
+ }
165
+ }
166
+
167
+ .anchor-heading {
168
+ position: absolute;
169
+ right: -$sp-4;
170
+ width: $sp-5;
171
+ height: 100%;
172
+ padding-right: $sp-1;
173
+ padding-left: $sp-1;
174
+ overflow: visible;
175
+
176
+ @include mq(md) {
177
+ right: auto;
178
+ left: -$sp-5;
179
+ }
180
+
181
+ svg {
182
+ display: inline-block;
183
+ width: 100%;
184
+ height: 100%;
185
+ color: $link-color;
186
+ visibility: hidden;
187
+ }
188
+ }
189
+
190
+ .anchor-heading:hover,
191
+ h1:hover > .anchor-heading,
192
+ h2:hover > .anchor-heading,
193
+ h3:hover > .anchor-heading,
194
+ h4:hover > .anchor-heading,
195
+ h5:hover > .anchor-heading,
196
+ h6:hover > .anchor-heading {
197
+ svg {
198
+ visibility: visible;
199
+ }
200
+ }
201
+
202
+ summary {
203
+ cursor: pointer;
204
+ }
205
+
206
+ h1,
207
+ h2,
208
+ h3,
209
+ h4,
210
+ h5,
211
+ h6 {
212
+ position: relative;
213
+ margin-top: 1.5em;
214
+ margin-bottom: 0.25em;
215
+
216
+ &:first-child {
217
+ margin-top: $sp-2;
218
+ }
219
+
220
+ + table,
221
+ + .table-wrapper,
222
+ + .code-example,
223
+ + .highlighter-rouge {
224
+ margin-top: 1em;
225
+ }
226
+
227
+ + p {
228
+ margin-top: 0;
229
+ }
230
+ }
231
+ }