just-the-docs 0.2.8 → 0.3.3

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.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -1
  3. data/_includes/css/custom.scss.liquid +1 -0
  4. data/_includes/css/just-the-docs.scss.liquid +7 -0
  5. data/_includes/fix_linenos.html +65 -0
  6. data/_includes/footer_custom.html +3 -0
  7. data/_includes/head.html +7 -7
  8. data/_includes/header_custom.html +0 -0
  9. data/_includes/nav.html +94 -35
  10. data/_includes/vendor/anchor_headings.html +53 -9
  11. data/_layouts/default.html +176 -76
  12. data/_layouts/table_wrappers.html +1 -1
  13. data/_sass/base.scss +14 -17
  14. data/_sass/code.scss +291 -74
  15. data/_sass/color_schemes/dark.scss +1 -1
  16. data/_sass/color_schemes/light.scss +0 -0
  17. data/_sass/content.scss +76 -5
  18. data/_sass/custom/custom.scss +0 -129
  19. data/_sass/labels.scss +5 -4
  20. data/_sass/layout.scss +48 -52
  21. data/_sass/modules.scss +20 -0
  22. data/_sass/navigation.scss +149 -50
  23. data/_sass/print.scss +40 -0
  24. data/_sass/search.scss +204 -48
  25. data/_sass/support/_functions.scss +2 -3
  26. data/_sass/support/_variables.scss +33 -9
  27. data/_sass/support/mixins/_layout.scss +1 -3
  28. data/_sass/support/mixins/_typography.scss +25 -22
  29. data/_sass/typography.scss +13 -7
  30. data/_sass/utilities/_layout.scss +74 -17
  31. data/_sass/utilities/_spacing.scss +69 -25
  32. data/_sass/vendor/normalize.scss/README.md +4 -75
  33. data/_sass/vendor/normalize.scss/normalize.scss +157 -235
  34. data/assets/css/just-the-docs-dark.scss +3 -0
  35. data/assets/css/just-the-docs-default.scss +8 -0
  36. data/assets/css/just-the-docs-light.scss +3 -0
  37. data/assets/js/just-the-docs.js +374 -202
  38. data/assets/js/zzzz-search-data.json +72 -0
  39. data/lib/tasks/search.rake +69 -10
  40. metadata +15 -15
  41. data/_sass/overrides.scss +0 -3
  42. data/_sass/vendor/normalize.scss/package.json +0 -70
  43. data/assets/css/dark-mode-preview.scss +0 -45
  44. data/assets/css/just-the-docs.scss +0 -49
  45. data/assets/js/dark-mode-preview.js +0 -23
  46. data/assets/js/search-data.json +0 -12
@@ -4,4 +4,4 @@ layout: vendor/compress
4
4
 
5
5
  {% assign content_ = content | replace: '<table', '<div class="table-wrapper"><table' %}
6
6
  {% assign content_ = content_ | replace: '</table>', '</table></div>' %}
7
- {{ content_ }}
7
+ {{ content_ }}
@@ -14,6 +14,7 @@
14
14
 
15
15
  html {
16
16
  @include fs-4;
17
+ scroll-behavior: smooth;
17
18
  }
18
19
 
19
20
  body {
@@ -24,25 +25,18 @@ body {
24
25
  background-color: $body-background-color;
25
26
  }
26
27
 
27
- p,
28
- h1,
29
- h2,
30
- h3,
31
- h4,
32
- h5,
33
- h6,
34
28
  ol,
35
29
  ul,
30
+ dl,
36
31
  pre,
37
32
  address,
38
33
  blockquote,
39
- dl,
34
+ table,
40
35
  div,
41
- fieldset,
42
- form,
43
36
  hr,
44
- noscript,
45
- table {
37
+ form,
38
+ fieldset,
39
+ noscript .table-wrapper {
46
40
  margin-top: 0;
47
41
  }
48
42
 
@@ -52,14 +46,15 @@ h3,
52
46
  h4,
53
47
  h5,
54
48
  h6 {
55
- margin-top: 1.2em;
56
- margin-bottom: 0.8em;
49
+ margin-top: 0;
50
+ margin-bottom: 1em;
57
51
  font-weight: 500;
58
52
  line-height: $body-heading-line-height;
59
53
  color: $body-heading-color;
60
54
  }
61
55
 
62
56
  p {
57
+ margin-top: 1em;
63
58
  margin-bottom: 1em;
64
59
  }
65
60
 
@@ -76,15 +71,17 @@ a:not([class]) {
76
71
  background-size: 1px 1px;
77
72
 
78
73
  &:hover {
79
- background-image: linear-gradient(rgba($link-color, 0.45) 0%, rgba($link-color, 0.45) 100%);
74
+ background-image: linear-gradient(
75
+ rgba($link-color, 0.45) 0%,
76
+ rgba($link-color, 0.45) 100%
77
+ );
80
78
  background-size: 1px 1px;
81
-
82
79
  }
83
80
  }
84
81
 
85
82
  code {
86
83
  font-family: $mono-font-family;
87
- font-size: 12px;
84
+ font-size: 0.75em;
88
85
  line-height: $body-line-height;
89
86
  }
90
87
 
@@ -11,93 +11,310 @@ code {
11
11
  border-radius: $border-radius;
12
12
  }
13
13
 
14
- pre.highlight,
15
- figure.highlight {
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 {
16
48
  padding: $sp-3;
17
- margin-bottom: 0;
18
- -webkit-overflow-scrolling: touch;
49
+ margin-top: 0;
50
+ margin-bottom: $sp-3;
51
+ overflow-x: auto;
19
52
  background-color: $code-background-color;
53
+ border-radius: $border-radius;
54
+ box-shadow: none;
55
+ -webkit-overflow-scrolling: touch;
20
56
 
57
+ div.highlight,
58
+ pre.highlight,
21
59
  code {
22
60
  padding: 0;
61
+ margin: 0;
23
62
  border: 0;
24
63
  }
25
64
  }
26
65
 
27
- .highlighter-rouge {
66
+ // {% highlight LANG %}...{% endhighlight %},
67
+ // {% highlight LANG linenos %}...{% endhighlight %}:
68
+ figure.highlight {
69
+ padding: $sp-3;
70
+ margin-top: 0;
28
71
  margin-bottom: $sp-3;
29
- overflow: hidden;
72
+ background-color: $code-background-color;
30
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
+ }
31
110
  }
32
111
 
33
- .highlight .c { color: #586e75; } // comment //
34
- .highlight .err { color: #93a1a1; } // error //
35
- .highlight .g { color: #93a1a1; } // generic //
36
- .highlight .k { color: #859900; } // keyword //
37
- .highlight .l { color: #93a1a1; } // literal //
38
- .highlight .n { color: #93a1a1; } // name //
39
- .highlight .o { color: #859900; } // operator //
40
- .highlight .x { color: #cb4b16; } // other //
41
- .highlight .p { color: #93a1a1; } // punctuation //
42
- .highlight .cm { color: #586e75; } // comment.multiline //
43
- .highlight .cp { color: #859900; } // comment.preproc //
44
- .highlight .c1 { color: #586e75; } // comment.single //
45
- .highlight .cs { color: #859900; } // comment.special //
46
- .highlight .gd { color: #2aa198; } // generic.deleted //
47
- .highlight .ge { font-style: italic; color: #93a1a1; } // generic.emph //
48
- .highlight .gr { color: #dc322f; } // generic.error //
49
- .highlight .gh { color: #cb4b16; } // generic.heading //
50
- .highlight .gi { color: #859900; } // generic.inserted //
51
- .highlight .go { color: #93a1a1; } // generic.output //
52
- .highlight .gp { color: #93a1a1; } // generic.prompt //
53
- .highlight .gs { font-weight: bold; color: #93a1a1; } // generic.strong //
54
- .highlight .gu { color: #cb4b16; } // generic.subheading //
55
- .highlight .gt { color: #93a1a1; } // generic.traceback //
56
- .highlight .kc { color: #cb4b16; } // keyword.constant //
57
- .highlight .kd { color: #268bd2; } // keyword.declaration //
58
- .highlight .kn { color: #859900; } // keyword.namespace //
59
- .highlight .kp { color: #859900; } // keyword.pseudo //
60
- .highlight .kr { color: #268bd2; } // keyword.reserved //
61
- .highlight .kt { color: #dc322f; } // keyword.type //
62
- .highlight .ld { color: #93a1a1; } // literal.date //
63
- .highlight .m { color: #2aa198; } // literal.number //
64
- .highlight .s { color: #2aa198; } // literal.string //
65
- .highlight .na { color: #555; } // name.attribute //
66
- .highlight .nb { color: #b58900; } // name.builtin //
67
- .highlight .nc { color: #268bd2; } // name.class //
68
- .highlight .no { color: #cb4b16; } // name.constant //
69
- .highlight .nd { color: #268bd2; } // name.decorator //
70
- .highlight .ni { color: #cb4b16; } // name.entity //
71
- .highlight .ne { color: #cb4b16; } // name.exception //
72
- .highlight .nf { color: #268bd2; } // name.function //
73
- .highlight .nl { color: #555; } // name.label //
74
- .highlight .nn { color: #93a1a1; } // name.namespace //
75
- .highlight .nx { color: #555; } // name.other //
76
- .highlight .py { color: #93a1a1; } // name.property //
77
- .highlight .nt { color: #268bd2; } // name.tag //
78
- .highlight .nv { color: #268bd2; } // name.variable //
79
- .highlight .ow { color: #859900; } // operator.word //
80
- .highlight .w { color: #93a1a1; } // text.whitespace //
81
- .highlight .mf { color: #2aa198; } // literal.number.float //
82
- .highlight .mh { color: #2aa198; } // literal.number.hex //
83
- .highlight .mi { color: #2aa198; } // literal.number.integer //
84
- .highlight .mo { color: #2aa198; } // literal.number.oct //
85
- .highlight .sb { color: #586e75; } // literal.string.backtick //
86
- .highlight .sc { color: #2aa198; } // literal.string.char //
87
- .highlight .sd { color: #93a1a1; } // literal.string.doc //
88
- .highlight .s2 { color: #2aa198; } // literal.string.double //
89
- .highlight .se { color: #cb4b16; } // literal.string.escape //
90
- .highlight .sh { color: #93a1a1; } // literal.string.heredoc //
91
- .highlight .si { color: #2aa198; } // literal.string.interpol //
92
- .highlight .sx { color: #2aa198; } // literal.string.other //
93
- .highlight .sr { color: #dc322f; } // literal.string.regex //
94
- .highlight .s1 { color: #2aa198; } // literal.string.single //
95
- .highlight .ss { color: #2aa198; } // literal.string.symbol //
96
- .highlight .bp { color: #268bd2; } // name.builtin.pseudo //
97
- .highlight .vc { color: #268bd2; } // name.variable.class //
98
- .highlight .vg { color: #268bd2; } // name.variable.global //
99
- .highlight .vi { color: #268bd2; } // name.variable.instance //
100
- .highlight .il { color: #2aa198; } // literal.number.integer.long //
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 //
101
318
 
102
319
  //
103
320
  // Code examples (rendered)