just-the-docs 0.3.3 → 0.4.0.rc1

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 (53) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +484 -0
  3. data/README.md +18 -5
  4. data/_includes/css/callouts.scss.liquid +93 -0
  5. data/_includes/css/just-the-docs.scss.liquid +2 -1
  6. data/_includes/favicon.html +1 -0
  7. data/_includes/head.html +6 -1
  8. data/_includes/icons/external_link.html +5 -0
  9. data/_includes/mermaid_config.js +1 -0
  10. data/_includes/nav.html +48 -5
  11. data/_includes/nav_footer_custom.html +0 -0
  12. data/_includes/search_placeholder_custom.html +1 -0
  13. data/_layouts/default.html +52 -29
  14. data/_sass/base.scss +5 -4
  15. data/_sass/buttons.scss +0 -2
  16. data/_sass/code.scss +20 -211
  17. data/_sass/color_schemes/dark.scss +15 -4
  18. data/_sass/color_schemes/light.scss +208 -0
  19. data/_sass/content.scss +27 -19
  20. data/_sass/custom/custom.scss +4 -0
  21. data/_sass/labels.scss +1 -2
  22. data/_sass/layout.scss +3 -2
  23. data/_sass/modules.scss +1 -5
  24. data/_sass/navigation.scss +29 -3
  25. data/_sass/print.scss +1 -1
  26. data/_sass/search.scss +1 -2
  27. data/_sass/support/_functions.scss +4 -4
  28. data/_sass/support/_variables.scss +8 -32
  29. data/_sass/support/mixins/_layout.scss +1 -1
  30. data/_sass/tables.scss +1 -2
  31. data/_sass/typography.scss +6 -6
  32. data/_sass/utilities/_colors.scss +0 -2
  33. data/_sass/utilities/_layout.scss +9 -3
  34. data/_sass/utilities/_lists.scss +1 -3
  35. data/_sass/utilities/_spacing.scss +1 -4
  36. data/_sass/utilities/_typography.scss +0 -6
  37. data/_sass/vendor/OneDarkJekyll/LICENSE +21 -0
  38. data/_sass/vendor/OneDarkJekyll/README.md +25 -0
  39. data/_sass/vendor/OneDarkJekyll/colors.less +30 -0
  40. data/_sass/vendor/OneDarkJekyll/syntax-firewatch-green.scss +200 -0
  41. data/_sass/vendor/OneDarkJekyll/syntax-firewatch.scss +200 -0
  42. data/_sass/vendor/OneDarkJekyll/syntax-one-dark-vivid.scss +200 -0
  43. data/_sass/vendor/OneDarkJekyll/syntax-one-dark.scss +200 -0
  44. data/_sass/vendor/OneDarkJekyll/syntax-variables.less +56 -0
  45. data/_sass/vendor/OneDarkJekyll/syntax.less +93 -0
  46. data/_sass/vendor/normalize.scss/normalize.scss +4 -2
  47. data/assets/images/large-image.jpg +0 -0
  48. data/assets/images/small-image.jpg +0 -0
  49. data/assets/js/just-the-docs.js +15 -2
  50. data/assets/js/zzzz-search-data.json +3 -3
  51. data/favicon.ico +0 -0
  52. data/lib/tasks/search.rake +1 -1
  53. metadata +36 -17
@@ -1,22 +1,23 @@
1
- // stylelint-disable primer/selector-no-utility, primer/no-override
2
- //
3
1
  // Utility classes for layout
4
- //
5
2
 
6
3
  // Display
7
4
 
8
5
  .d-block {
9
6
  display: block !important;
10
7
  }
8
+
11
9
  .d-flex {
12
10
  display: flex !important;
13
11
  }
12
+
14
13
  .d-inline {
15
14
  display: inline !important;
16
15
  }
16
+
17
17
  .d-inline-block {
18
18
  display: inline-block !important;
19
19
  }
20
+
20
21
  .d-none {
21
22
  display: none !important;
22
23
  }
@@ -78,18 +79,23 @@
78
79
  .v-align-baseline {
79
80
  vertical-align: baseline !important;
80
81
  }
82
+
81
83
  .v-align-bottom {
82
84
  vertical-align: bottom !important;
83
85
  }
86
+
84
87
  .v-align-middle {
85
88
  vertical-align: middle !important;
86
89
  }
90
+
87
91
  .v-align-text-bottom {
88
92
  vertical-align: text-bottom !important;
89
93
  }
94
+
90
95
  .v-align-text-top {
91
96
  vertical-align: text-top !important;
92
97
  }
98
+
93
99
  .v-align-top {
94
100
  vertical-align: top !important;
95
101
  }
@@ -1,8 +1,6 @@
1
- //
2
1
  // Utility classes for lists
3
- //
4
2
 
5
- // stylelint-disable primer/selector-no-utility, primer/no-override, selector-max-type
3
+ // stylelint-disable selector-max-type
6
4
 
7
5
  .list-style-none {
8
6
  padding: 0 !important;
@@ -1,9 +1,6 @@
1
- //
2
1
  // Utility classes for margins and padding
3
- //
4
2
 
5
- // scss-lint:disable SpaceAfterPropertyName
6
- // stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before, primer/selector-no-utility, primer/no-override
3
+ // stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before
7
4
 
8
5
  // Margin spacer utilities
9
6
 
@@ -1,8 +1,4 @@
1
- //
2
1
  // Utility classes for typography
3
- //
4
-
5
- // stylelint-disable primer/selector-no-utility, primer/no-override
6
2
 
7
3
  .fs-1 {
8
4
  @include fs-1;
@@ -87,5 +83,3 @@
87
83
  .text-uppercase {
88
84
  text-transform: uppercase !important;
89
85
  }
90
-
91
- // stylelint-enable primer/selector-no-utility
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2016 Mihály Gyöngyösi
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,25 @@
1
+ # OneDarkJekyll
2
+
3
+ *Use Atom's One Dark syntax colors in your Jekyll powered blog!*
4
+
5
+ It's LESS file which can be compiled to a - Pygments, Rouge compatible - stylesheet from Atom editor's One Dark syntax theme (and any theme based on it, for example One Dark Vivid, Firewatch, etc.).
6
+
7
+ Download the stylesheet files or compile a new one from any Atom syntax theme which based on One Dark (the variable names in `colors.less` must match with One Dark's)
8
+
9
+ ## Create a new syntax stylesheet
10
+
11
+ 1. `npm install -g less less-plugin-clean-css`
12
+ 2. Clone this repository
13
+ 3. Download the `colors.css` file from the syntax theme's repository (for example https://github.com/atom/one-dark-syntax/blob/master/styles/colors.less in case of One-Dark)
14
+ 4. Put the previously downloaded file next to `syntax.less`
15
+ 5. Run `lessc syntax.less syntax.css --clean-css`
16
+ 6. Use the `syntax.css`
17
+
18
+ It's not final and in case you find any error/improvement feel free to create a PR. :)
19
+
20
+ ----
21
+
22
+ # UPDATES FOR USE IN JUST-THE-DOCS:
23
+
24
+ 1. Layout added in `*.css`
25
+ 2. Renamed `*.css` to `*.scss`
@@ -0,0 +1,30 @@
1
+ // Config -----------------------------------
2
+ @syntax-hue: 220;
3
+ @syntax-saturation: 13%;
4
+ @syntax-brightness: 18%;
5
+
6
+
7
+ // Monochrome -----------------------------------
8
+ @mono-1: hsl(@syntax-hue, 14%, 71%); // default text
9
+ @mono-2: hsl(@syntax-hue, 9%, 55%);
10
+ @mono-3: hsl(@syntax-hue, 10%, 40%);
11
+
12
+ // Colors -----------------------------------
13
+ @hue-1: hsl(187, 47%, 55%); // <-cyan
14
+ @hue-2: hsl(207, 82%, 66%); // <-blue
15
+ @hue-3: hsl(286, 60%, 67%); // <-purple
16
+ @hue-4: hsl( 95, 38%, 62%); // <-green
17
+
18
+ @hue-5: hsl(355, 65%, 65%); // <-red 1
19
+ @hue-5-2: hsl( 5, 48%, 51%); // <-red 2
20
+
21
+ @hue-6: hsl( 29, 54%, 61%); // <-orange 1
22
+ @hue-6-2: hsl( 39, 67%, 69%); // <-orange 2
23
+
24
+
25
+ // Base colors -----------------------------------
26
+ @syntax-fg: @mono-1;
27
+ @syntax-bg: hsl(@syntax-hue, @syntax-saturation, @syntax-brightness);
28
+ @syntax-gutter: darken(@syntax-fg, 26%);
29
+ @syntax-guide: fade(@syntax-fg, 15%);
30
+ @syntax-accent: hsl(@syntax-hue, 100%, 66% );
@@ -0,0 +1,200 @@
1
+ .highlight,
2
+ pre.highlight {
3
+ background: #282c34;
4
+ color: #abb2bf;
5
+ }
6
+ .highlight pre {
7
+ background: #282c34;
8
+ }
9
+ .highlight .hll {
10
+ background: #282c34;
11
+ }
12
+ .highlight .c {
13
+ color: #5c6370;
14
+ font-style: italic;
15
+ }
16
+ .highlight .err {
17
+ color: #960050;
18
+ background-color: #1e0010;
19
+ }
20
+ .highlight .k {
21
+ color: #5ba473;
22
+ }
23
+ .highlight .l {
24
+ color: #c8ae9d;
25
+ }
26
+ .highlight .n {
27
+ color: #abb2bf;
28
+ }
29
+ .highlight .o {
30
+ color: #abb2bf;
31
+ }
32
+ .highlight .p {
33
+ color: #abb2bf;
34
+ }
35
+ .highlight .cm {
36
+ color: #5c6370;
37
+ font-style: italic;
38
+ }
39
+ .highlight .cp {
40
+ color: #5c6370;
41
+ font-style: italic;
42
+ }
43
+ .highlight .c1 {
44
+ color: #5c6370;
45
+ font-style: italic;
46
+ }
47
+ .highlight .cs {
48
+ color: #5c6370;
49
+ font-style: italic;
50
+ }
51
+ .highlight .ge {
52
+ font-style: italic;
53
+ }
54
+ .highlight .gs {
55
+ font-weight: 700;
56
+ }
57
+ .highlight .kc {
58
+ color: #5ba473;
59
+ }
60
+ .highlight .kd {
61
+ color: #5ba473;
62
+ }
63
+ .highlight .kn {
64
+ color: #5ba473;
65
+ }
66
+ .highlight .kp {
67
+ color: #5ba473;
68
+ }
69
+ .highlight .kr {
70
+ color: #5ba473;
71
+ }
72
+ .highlight .kt {
73
+ color: #5ba473;
74
+ }
75
+ .highlight .ld {
76
+ color: #c8ae9d;
77
+ }
78
+ .highlight .m {
79
+ color: #d19a66;
80
+ }
81
+ .highlight .s {
82
+ color: #c8ae9d;
83
+ }
84
+ .highlight .na {
85
+ color: #d19a66;
86
+ }
87
+ .highlight .nb {
88
+ color: #e5c07b;
89
+ }
90
+ .highlight .nc {
91
+ color: #e5c07b;
92
+ }
93
+ .highlight .no {
94
+ color: #e5c07b;
95
+ }
96
+ .highlight .nd {
97
+ color: #e5c07b;
98
+ }
99
+ .highlight .ni {
100
+ color: #e5c07b;
101
+ }
102
+ .highlight .ne {
103
+ color: #e5c07b;
104
+ }
105
+ .highlight .nf {
106
+ color: #abb2bf;
107
+ }
108
+ .highlight .nl {
109
+ color: #e5c07b;
110
+ }
111
+ .highlight .nn {
112
+ color: #abb2bf;
113
+ }
114
+ .highlight .nx {
115
+ color: #abb2bf;
116
+ }
117
+ .highlight .py {
118
+ color: #e5c07b;
119
+ }
120
+ .highlight .nt {
121
+ color: #77b181;
122
+ }
123
+ .highlight .nv {
124
+ color: #e5c07b;
125
+ }
126
+ .highlight .ow {
127
+ font-weight: 700;
128
+ }
129
+ .highlight .w {
130
+ color: #f8f8f2;
131
+ }
132
+ .highlight .mf {
133
+ color: #d19a66;
134
+ }
135
+ .highlight .mh {
136
+ color: #d19a66;
137
+ }
138
+ .highlight .mi {
139
+ color: #d19a66;
140
+ }
141
+ .highlight .mo {
142
+ color: #d19a66;
143
+ }
144
+ .highlight .sb {
145
+ color: #c8ae9d;
146
+ }
147
+ .highlight .sc {
148
+ color: #c8ae9d;
149
+ }
150
+ .highlight .sd {
151
+ color: #c8ae9d;
152
+ }
153
+ .highlight .s2 {
154
+ color: #c8ae9d;
155
+ }
156
+ .highlight .se {
157
+ color: #c8ae9d;
158
+ }
159
+ .highlight .sh {
160
+ color: #c8ae9d;
161
+ }
162
+ .highlight .si {
163
+ color: #c8ae9d;
164
+ }
165
+ .highlight .sx {
166
+ color: #c8ae9d;
167
+ }
168
+ .highlight .sr {
169
+ color: #56b6c2;
170
+ }
171
+ .highlight .s1 {
172
+ color: #c8ae9d;
173
+ }
174
+ .highlight .ss {
175
+ color: #56b6c2;
176
+ }
177
+ .highlight .bp {
178
+ color: #e5c07b;
179
+ }
180
+ .highlight .vc {
181
+ color: #e5c07b;
182
+ }
183
+ .highlight .vg {
184
+ color: #e5c07b;
185
+ }
186
+ .highlight .vi {
187
+ color: #77b181;
188
+ }
189
+ .highlight .il {
190
+ color: #d19a66;
191
+ }
192
+ .highlight .gu {
193
+ color: #75715e;
194
+ }
195
+ .highlight .gd {
196
+ color: #f92672;
197
+ }
198
+ .highlight .gi {
199
+ color: #a6e22e;
200
+ }
@@ -0,0 +1,200 @@
1
+ .highlight,
2
+ pre.highlight {
3
+ background: #282c34;
4
+ color: #abb2bf;
5
+ }
6
+ .highlight pre {
7
+ background: #282c34;
8
+ }
9
+ .highlight .hll {
10
+ background: #282c34;
11
+ }
12
+ .highlight .c {
13
+ color: #5c6370;
14
+ font-style: italic;
15
+ }
16
+ .highlight .err {
17
+ color: #960050;
18
+ background-color: #1e0010;
19
+ }
20
+ .highlight .k {
21
+ color: #dd672c;
22
+ }
23
+ .highlight .l {
24
+ color: #c8ae9d;
25
+ }
26
+ .highlight .n {
27
+ color: #abb2bf;
28
+ }
29
+ .highlight .o {
30
+ color: #abb2bf;
31
+ }
32
+ .highlight .p {
33
+ color: #abb2bf;
34
+ }
35
+ .highlight .cm {
36
+ color: #5c6370;
37
+ font-style: italic;
38
+ }
39
+ .highlight .cp {
40
+ color: #5c6370;
41
+ font-style: italic;
42
+ }
43
+ .highlight .c1 {
44
+ color: #5c6370;
45
+ font-style: italic;
46
+ }
47
+ .highlight .cs {
48
+ color: #5c6370;
49
+ font-style: italic;
50
+ }
51
+ .highlight .ge {
52
+ font-style: italic;
53
+ }
54
+ .highlight .gs {
55
+ font-weight: 700;
56
+ }
57
+ .highlight .kc {
58
+ color: #dd672c;
59
+ }
60
+ .highlight .kd {
61
+ color: #dd672c;
62
+ }
63
+ .highlight .kn {
64
+ color: #dd672c;
65
+ }
66
+ .highlight .kp {
67
+ color: #dd672c;
68
+ }
69
+ .highlight .kr {
70
+ color: #dd672c;
71
+ }
72
+ .highlight .kt {
73
+ color: #dd672c;
74
+ }
75
+ .highlight .ld {
76
+ color: #c8ae9d;
77
+ }
78
+ .highlight .m {
79
+ color: #d19a66;
80
+ }
81
+ .highlight .s {
82
+ color: #c8ae9d;
83
+ }
84
+ .highlight .na {
85
+ color: #d19a66;
86
+ }
87
+ .highlight .nb {
88
+ color: #e5c07b;
89
+ }
90
+ .highlight .nc {
91
+ color: #e5c07b;
92
+ }
93
+ .highlight .no {
94
+ color: #e5c07b;
95
+ }
96
+ .highlight .nd {
97
+ color: #e5c07b;
98
+ }
99
+ .highlight .ni {
100
+ color: #e5c07b;
101
+ }
102
+ .highlight .ne {
103
+ color: #e5c07b;
104
+ }
105
+ .highlight .nf {
106
+ color: #abb2bf;
107
+ }
108
+ .highlight .nl {
109
+ color: #e5c07b;
110
+ }
111
+ .highlight .nn {
112
+ color: #abb2bf;
113
+ }
114
+ .highlight .nx {
115
+ color: #abb2bf;
116
+ }
117
+ .highlight .py {
118
+ color: #e5c07b;
119
+ }
120
+ .highlight .nt {
121
+ color: #e06c75;
122
+ }
123
+ .highlight .nv {
124
+ color: #e5c07b;
125
+ }
126
+ .highlight .ow {
127
+ font-weight: 700;
128
+ }
129
+ .highlight .w {
130
+ color: #f8f8f2;
131
+ }
132
+ .highlight .mf {
133
+ color: #d19a66;
134
+ }
135
+ .highlight .mh {
136
+ color: #d19a66;
137
+ }
138
+ .highlight .mi {
139
+ color: #d19a66;
140
+ }
141
+ .highlight .mo {
142
+ color: #d19a66;
143
+ }
144
+ .highlight .sb {
145
+ color: #c8ae9d;
146
+ }
147
+ .highlight .sc {
148
+ color: #c8ae9d;
149
+ }
150
+ .highlight .sd {
151
+ color: #c8ae9d;
152
+ }
153
+ .highlight .s2 {
154
+ color: #c8ae9d;
155
+ }
156
+ .highlight .se {
157
+ color: #c8ae9d;
158
+ }
159
+ .highlight .sh {
160
+ color: #c8ae9d;
161
+ }
162
+ .highlight .si {
163
+ color: #c8ae9d;
164
+ }
165
+ .highlight .sx {
166
+ color: #c8ae9d;
167
+ }
168
+ .highlight .sr {
169
+ color: #56b6c2;
170
+ }
171
+ .highlight .s1 {
172
+ color: #c8ae9d;
173
+ }
174
+ .highlight .ss {
175
+ color: #56b6c2;
176
+ }
177
+ .highlight .bp {
178
+ color: #e5c07b;
179
+ }
180
+ .highlight .vc {
181
+ color: #e5c07b;
182
+ }
183
+ .highlight .vg {
184
+ color: #e5c07b;
185
+ }
186
+ .highlight .vi {
187
+ color: #e06c75;
188
+ }
189
+ .highlight .il {
190
+ color: #d19a66;
191
+ }
192
+ .highlight .gu {
193
+ color: #75715e;
194
+ }
195
+ .highlight .gd {
196
+ color: #f92672;
197
+ }
198
+ .highlight .gi {
199
+ color: #a6e22e;
200
+ }