just-the-docs-peter 0.1.0 → 0.1.1

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 (96) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1508 -0
  3. data/LICENSE.txt +21 -0
  4. data/README.md +110 -0
  5. data/Rakefile +1 -0
  6. data/_includes/components/aux_nav.html +15 -0
  7. data/_includes/components/breadcrumbs.html +43 -0
  8. data/_includes/components/children_nav.html +33 -0
  9. data/_includes/components/footer.html +34 -0
  10. data/_includes/components/header.html +11 -0
  11. data/_includes/components/mermaid.html +45 -0
  12. data/_includes/components/search_footer.html +7 -0
  13. data/_includes/components/search_header.html +9 -0
  14. data/_includes/components/sidebar.html +71 -0
  15. data/_includes/css/callouts.scss.liquid +93 -0
  16. data/_includes/css/custom.scss.liquid +1 -0
  17. data/_includes/css/just-the-docs.scss.liquid +12 -0
  18. data/_includes/fix_linenos.html +65 -0
  19. data/_includes/footer_custom.html +3 -0
  20. data/_includes/head.html +42 -0
  21. data/_includes/head_custom.html +0 -0
  22. data/_includes/header_custom.html +0 -0
  23. data/_includes/icons/code_copy.html +15 -0
  24. data/_includes/icons/document.html +6 -0
  25. data/_includes/icons/expand.html +6 -0
  26. data/_includes/icons/external_link.html +5 -0
  27. data/_includes/icons/icons.html +13 -0
  28. data/_includes/icons/link.html +6 -0
  29. data/_includes/icons/menu.html +6 -0
  30. data/_includes/icons/search.html +6 -0
  31. data/_includes/js/custom.js +0 -0
  32. data/_includes/lunr/custom-data.json +0 -0
  33. data/_includes/lunr/custom-index.js +0 -0
  34. data/_includes/mermaid_config.js +1 -0
  35. data/_includes/nav.html +106 -0
  36. data/_includes/nav_footer_custom.html +0 -0
  37. data/_includes/search_placeholder_custom.html +1 -0
  38. data/_includes/sorted_pages.html +95 -0
  39. data/_includes/title.html +5 -0
  40. data/_includes/toc_heading_custom.html +1 -0
  41. data/_includes/vendor/anchor_headings.html +172 -0
  42. data/_layouts/about.html +5 -0
  43. data/_layouts/default.html +41 -0
  44. data/_layouts/home.html +5 -0
  45. data/_layouts/minimal.html +34 -0
  46. data/_layouts/page.html +5 -0
  47. data/_layouts/post.html +5 -0
  48. data/_layouts/table_wrappers.html +7 -0
  49. data/_layouts/vendor/compress.html +10 -0
  50. data/_sass/base.scss +109 -0
  51. data/_sass/buttons.scss +123 -0
  52. data/_sass/code.scss +246 -0
  53. data/_sass/color_schemes/dark.scss +17 -0
  54. data/_sass/color_schemes/legacy_light.scss +208 -0
  55. data/_sass/color_schemes/light.scss +15 -0
  56. data/_sass/color_schemes/light_peter.scss +15 -0
  57. data/_sass/content.scss +239 -0
  58. data/_sass/custom/custom.scss +1 -0
  59. data/_sass/custom/setup.scss +1 -0
  60. data/_sass/labels.scss +33 -0
  61. data/_sass/layout.scss +209 -0
  62. data/_sass/modules.scss +17 -0
  63. data/_sass/navigation.scss +235 -0
  64. data/_sass/print.scss +40 -0
  65. data/_sass/search.scss +311 -0
  66. data/_sass/skiptomain.scss +30 -0
  67. data/_sass/support/_variables.scss +116 -0
  68. data/_sass/support/mixins/_buttons.scss +27 -0
  69. data/_sass/support/mixins/_layout.scss +33 -0
  70. data/_sass/support/mixins/_typography.scss +84 -0
  71. data/_sass/support/mixins/mixins.scss +3 -0
  72. data/_sass/support/support.scss +2 -0
  73. data/_sass/tables.scss +54 -0
  74. data/_sass/typography.scss +63 -0
  75. data/_sass/utilities/_colors.scss +237 -0
  76. data/_sass/utilities/_layout.scss +101 -0
  77. data/_sass/utilities/_lists.scss +15 -0
  78. data/_sass/utilities/_spacing.scss +162 -0
  79. data/_sass/utilities/_typography.scss +85 -0
  80. data/_sass/utilities/utilities.scss +5 -0
  81. data/_sass/vendor/OneDarkJekyll/LICENSE +21 -0
  82. data/_sass/vendor/OneDarkJekyll/syntax.scss +202 -0
  83. data/_sass/vendor/OneLightJekyll/LICENSE +65 -0
  84. data/_sass/vendor/OneLightJekyll/syntax.scss +208 -0
  85. data/_sass/vendor/normalize.scss/README.md +7 -0
  86. data/_sass/vendor/normalize.scss/normalize.scss +351 -0
  87. data/assets/css/just-the-docs-dark.scss +3 -0
  88. data/assets/css/just-the-docs-default.scss +8 -0
  89. data/assets/css/just-the-docs-light.scss +3 -0
  90. data/assets/js/just-the-docs.js +535 -0
  91. data/assets/js/vendor/lunr.min.js +61 -0
  92. data/assets/js/zzzz-search-data.json +74 -0
  93. data/bin/just-the-docs +16 -0
  94. data/favicon.ico +0 -0
  95. data/lib/tasks/search.rake +88 -0
  96. metadata +152 -11
@@ -0,0 +1,27 @@
1
+ // Colored button
2
+
3
+ @mixin btn-color($fg, $bg) {
4
+ color: $fg;
5
+ background-color: darken($bg, 2%);
6
+ background-image: linear-gradient(lighten($bg, 5%), darken($bg, 2%));
7
+ box-shadow: 0 1px 3px rgba(0, 0, 0, 0.25), 0 4px 10px rgba(0, 0, 0, 0.12);
8
+
9
+ &:hover,
10
+ &.zeroclipboard-is-hover {
11
+ color: $fg;
12
+ background-color: darken($bg, 4%);
13
+ background-image: linear-gradient((lighten($bg, 2%), darken($bg, 4%)));
14
+ }
15
+
16
+ &:active,
17
+ &.selected,
18
+ &.zeroclipboard-is-active {
19
+ background-color: darken($bg, 5%);
20
+ background-image: none;
21
+ box-shadow: inset 0 2px 4px rgba(0, 0, 0, 0.15);
22
+ }
23
+
24
+ &.selected:hover {
25
+ background-color: darken($bg, 10%);
26
+ }
27
+ }
@@ -0,0 +1,33 @@
1
+ // Media query
2
+
3
+ // Media query mixin
4
+ // Usage:
5
+ // @include mq(md) {
6
+ // ..medium and up styles
7
+ // }
8
+ @mixin mq($name) {
9
+ // Retrieves the value from the key
10
+ $value: map-get($media-queries, $name);
11
+
12
+ // If the key exists in the map
13
+ @if $value {
14
+ // Prints a media query based on the value
15
+ @media (min-width: $value) {
16
+ @content;
17
+ }
18
+ } @else {
19
+ @warn "No value could be retrieved from `#{$media-query}`. Please make sure it is defined in `$media-queries` map.";
20
+ }
21
+ }
22
+
23
+ // Responsive container
24
+
25
+ @mixin container {
26
+ padding-right: $gutter-spacing-sm;
27
+ padding-left: $gutter-spacing-sm;
28
+
29
+ @include mq(md) {
30
+ padding-right: $gutter-spacing;
31
+ padding-left: $gutter-spacing;
32
+ }
33
+ }
@@ -0,0 +1,84 @@
1
+ @mixin fs-1 {
2
+ font-size: $font-size-1 !important;
3
+
4
+ @include mq(sm) {
5
+ font-size: $font-size-1-sm !important;
6
+ }
7
+ }
8
+
9
+ @mixin fs-2 {
10
+ font-size: $font-size-2 !important;
11
+
12
+ @include mq(sm) {
13
+ font-size: $font-size-3 !important;
14
+ }
15
+ }
16
+
17
+ @mixin fs-3 {
18
+ font-size: $font-size-3 !important;
19
+
20
+ @include mq(sm) {
21
+ font-size: $font-size-4 !important;
22
+ }
23
+ }
24
+
25
+ @mixin fs-4 {
26
+ font-size: $font-size-4 !important;
27
+
28
+ @include mq(sm) {
29
+ font-size: $font-size-5 !important;
30
+ }
31
+ }
32
+
33
+ @mixin fs-5 {
34
+ font-size: $font-size-5 !important;
35
+
36
+ @include mq(sm) {
37
+ font-size: $font-size-6 !important;
38
+ }
39
+ }
40
+
41
+ @mixin fs-6 {
42
+ font-size: $font-size-6 !important;
43
+
44
+ @include mq(sm) {
45
+ font-size: $font-size-7 !important;
46
+ line-height: $body-heading-line-height;
47
+ }
48
+ }
49
+
50
+ @mixin fs-7 {
51
+ font-size: $font-size-7 !important;
52
+ line-height: $body-heading-line-height;
53
+
54
+ @include mq(sm) {
55
+ font-size: $font-size-8 !important;
56
+ }
57
+ }
58
+
59
+ @mixin fs-8 {
60
+ font-size: $font-size-8 !important;
61
+ line-height: $body-heading-line-height;
62
+
63
+ @include mq(sm) {
64
+ font-size: $font-size-9 !important;
65
+ }
66
+ }
67
+
68
+ @mixin fs-9 {
69
+ font-size: $font-size-9 !important;
70
+ line-height: $body-heading-line-height;
71
+
72
+ @include mq(sm) {
73
+ font-size: $font-size-10 !important;
74
+ }
75
+ }
76
+
77
+ @mixin fs-10 {
78
+ font-size: $font-size-10 !important;
79
+ line-height: $body-heading-line-height;
80
+
81
+ @include mq(sm) {
82
+ font-size: $font-size-10-sm !important;
83
+ }
84
+ }
@@ -0,0 +1,3 @@
1
+ @import "./layout";
2
+ @import "./buttons";
3
+ @import "./typography";
@@ -0,0 +1,2 @@
1
+ @import "./variables";
2
+ @import "./mixins/mixins";
data/_sass/tables.scss ADDED
@@ -0,0 +1,54 @@
1
+ // Tables
2
+ // stylelint-disable max-nesting-depth, selector-no-type, selector-max-type
3
+
4
+ .table-wrapper {
5
+ display: block;
6
+ width: 100%;
7
+ max-width: 100%;
8
+ margin-bottom: $sp-5;
9
+ overflow-x: auto;
10
+ border-radius: $border-radius;
11
+ box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
12
+ }
13
+
14
+ table {
15
+ display: table;
16
+ min-width: 100%;
17
+ border-collapse: separate;
18
+ }
19
+
20
+ th,
21
+ td {
22
+ @include fs-3;
23
+
24
+ min-width: 7.5rem;
25
+ padding: $sp-2 $sp-3;
26
+ background-color: $table-background-color;
27
+ border-bottom: $border rgba($border-color, 0.5);
28
+ border-left: $border $border-color;
29
+
30
+ &:first-of-type {
31
+ border-left: 0;
32
+ }
33
+ }
34
+
35
+ tbody {
36
+ tr {
37
+ &:last-of-type {
38
+ th,
39
+ td {
40
+ border-bottom: 0;
41
+ }
42
+
43
+ td {
44
+ padding-bottom: $sp-3;
45
+ }
46
+ }
47
+ }
48
+ }
49
+
50
+ thead {
51
+ th {
52
+ border-bottom: $border $border-color;
53
+ }
54
+ }
@@ -0,0 +1,63 @@
1
+ // Typography
2
+ // stylelint-disable selector-no-type, selector-max-type, selector-max-specificity, selector-max-id
3
+
4
+ h1,
5
+ .text-alpha {
6
+ @include fs-8;
7
+
8
+ font-weight: 300;
9
+ }
10
+
11
+ h2,
12
+ .text-beta,
13
+ #toctitle {
14
+ @include fs-6;
15
+ }
16
+
17
+ h3,
18
+ .text-gamma {
19
+ @include fs-5;
20
+ }
21
+
22
+ h4,
23
+ .text-delta {
24
+ @include fs-2;
25
+
26
+ font-weight: 400;
27
+ text-transform: uppercase;
28
+ letter-spacing: 0.1em;
29
+ }
30
+
31
+ h4 code {
32
+ text-transform: none;
33
+ }
34
+
35
+ h5,
36
+ .text-epsilon {
37
+ @include fs-3;
38
+ }
39
+
40
+ h6,
41
+ .text-zeta {
42
+ @include fs-2;
43
+ }
44
+
45
+ .text-small {
46
+ @include fs-2;
47
+ }
48
+
49
+ .text-mono {
50
+ font-family: $mono-font-family !important;
51
+ }
52
+
53
+ .text-left {
54
+ text-align: left !important;
55
+ }
56
+
57
+ .text-center {
58
+ text-align: center !important;
59
+ }
60
+
61
+ .text-right {
62
+ text-align: right !important;
63
+ }
@@ -0,0 +1,237 @@
1
+ // Utility classes for colors
2
+
3
+ // Text colors
4
+
5
+ .text-grey-dk-000 {
6
+ color: $grey-dk-000 !important;
7
+ }
8
+
9
+ .text-grey-dk-100 {
10
+ color: $grey-dk-100 !important;
11
+ }
12
+
13
+ .text-grey-dk-200 {
14
+ color: $grey-dk-200 !important;
15
+ }
16
+
17
+ .text-grey-dk-250 {
18
+ color: $grey-dk-250 !important;
19
+ }
20
+
21
+ .text-grey-dk-300 {
22
+ color: $grey-dk-300 !important;
23
+ }
24
+
25
+ .text-grey-lt-000 {
26
+ color: $grey-lt-000 !important;
27
+ }
28
+
29
+ .text-grey-lt-100 {
30
+ color: $grey-lt-100 !important;
31
+ }
32
+
33
+ .text-grey-lt-200 {
34
+ color: $grey-lt-200 !important;
35
+ }
36
+
37
+ .text-grey-lt-300 {
38
+ color: $grey-lt-300 !important;
39
+ }
40
+
41
+ .text-blue-000 {
42
+ color: $blue-000 !important;
43
+ }
44
+
45
+ .text-blue-100 {
46
+ color: $blue-100 !important;
47
+ }
48
+
49
+ .text-blue-200 {
50
+ color: $blue-200 !important;
51
+ }
52
+
53
+ .text-blue-300 {
54
+ color: $blue-300 !important;
55
+ }
56
+
57
+ .text-green-000 {
58
+ color: $green-000 !important;
59
+ }
60
+
61
+ .text-green-100 {
62
+ color: $green-100 !important;
63
+ }
64
+
65
+ .text-green-200 {
66
+ color: $green-200 !important;
67
+ }
68
+
69
+ .text-green-300 {
70
+ color: $green-300 !important;
71
+ }
72
+
73
+ .text-purple-000 {
74
+ color: $purple-000 !important;
75
+ }
76
+
77
+ .text-purple-100 {
78
+ color: $purple-100 !important;
79
+ }
80
+
81
+ .text-purple-200 {
82
+ color: $purple-200 !important;
83
+ }
84
+
85
+ .text-purple-300 {
86
+ color: $purple-300 !important;
87
+ }
88
+
89
+ .text-yellow-000 {
90
+ color: $yellow-000 !important;
91
+ }
92
+
93
+ .text-yellow-100 {
94
+ color: $yellow-100 !important;
95
+ }
96
+
97
+ .text-yellow-200 {
98
+ color: $yellow-200 !important;
99
+ }
100
+
101
+ .text-yellow-300 {
102
+ color: $yellow-300 !important;
103
+ }
104
+
105
+ .text-red-000 {
106
+ color: $red-000 !important;
107
+ }
108
+
109
+ .text-red-100 {
110
+ color: $red-100 !important;
111
+ }
112
+
113
+ .text-red-200 {
114
+ color: $red-200 !important;
115
+ }
116
+
117
+ .text-red-300 {
118
+ color: $red-300 !important;
119
+ }
120
+
121
+ // Background colors
122
+
123
+ .bg-grey-dk-000 {
124
+ background-color: $grey-dk-000 !important;
125
+ }
126
+
127
+ .bg-grey-dk-100 {
128
+ background-color: $grey-dk-100 !important;
129
+ }
130
+
131
+ .bg-grey-dk-200 {
132
+ background-color: $grey-dk-200 !important;
133
+ }
134
+
135
+ .bg-grey-dk-250 {
136
+ background-color: $grey-dk-250 !important;
137
+ }
138
+
139
+ .bg-grey-dk-300 {
140
+ background-color: $grey-dk-300 !important;
141
+ }
142
+
143
+ .bg-grey-lt-000 {
144
+ background-color: $grey-lt-000 !important;
145
+ }
146
+
147
+ .bg-grey-lt-100 {
148
+ background-color: $grey-lt-100 !important;
149
+ }
150
+
151
+ .bg-grey-lt-200 {
152
+ background-color: $grey-lt-200 !important;
153
+ }
154
+
155
+ .bg-grey-lt-300 {
156
+ background-color: $grey-lt-300 !important;
157
+ }
158
+
159
+ .bg-blue-000 {
160
+ background-color: $blue-000 !important;
161
+ }
162
+
163
+ .bg-blue-100 {
164
+ background-color: $blue-100 !important;
165
+ }
166
+
167
+ .bg-blue-200 {
168
+ background-color: $blue-200 !important;
169
+ }
170
+
171
+ .bg-blue-300 {
172
+ background-color: $blue-300 !important;
173
+ }
174
+
175
+ .bg-green-000 {
176
+ background-color: $green-000 !important;
177
+ }
178
+
179
+ .bg-green-100 {
180
+ background-color: $green-100 !important;
181
+ }
182
+
183
+ .bg-green-200 {
184
+ background-color: $green-200 !important;
185
+ }
186
+
187
+ .bg-green-300 {
188
+ background-color: $green-300 !important;
189
+ }
190
+
191
+ .bg-purple-000 {
192
+ background-color: $purple-000 !important;
193
+ }
194
+
195
+ .bg-purple-100 {
196
+ background-color: $purple-100 !important;
197
+ }
198
+
199
+ .bg-purple-200 {
200
+ background-color: $purple-200 !important;
201
+ }
202
+
203
+ .bg-purple-300 {
204
+ background-color: $purple-300 !important;
205
+ }
206
+
207
+ .bg-yellow-000 {
208
+ background-color: $yellow-000 !important;
209
+ }
210
+
211
+ .bg-yellow-100 {
212
+ background-color: $yellow-100 !important;
213
+ }
214
+
215
+ .bg-yellow-200 {
216
+ background-color: $yellow-200 !important;
217
+ }
218
+
219
+ .bg-yellow-300 {
220
+ background-color: $yellow-300 !important;
221
+ }
222
+
223
+ .bg-red-000 {
224
+ background-color: $red-000 !important;
225
+ }
226
+
227
+ .bg-red-100 {
228
+ background-color: $red-100 !important;
229
+ }
230
+
231
+ .bg-red-200 {
232
+ background-color: $red-200 !important;
233
+ }
234
+
235
+ .bg-red-300 {
236
+ background-color: $red-300 !important;
237
+ }
@@ -0,0 +1,101 @@
1
+ // Utility classes for layout
2
+
3
+ // Display
4
+
5
+ .d-block {
6
+ display: block !important;
7
+ }
8
+
9
+ .d-flex {
10
+ display: flex !important;
11
+ }
12
+
13
+ .d-inline {
14
+ display: inline !important;
15
+ }
16
+
17
+ .d-inline-block {
18
+ display: inline-block !important;
19
+ }
20
+
21
+ .d-none {
22
+ display: none !important;
23
+ }
24
+
25
+ @each $media-query in map-keys($media-queries) {
26
+ @for $i from 1 through length($spacers) {
27
+ @include mq($media-query) {
28
+ $size: #{map-get($spacers, sp-#{$i - 1})};
29
+ $scale: #{$i - 1};
30
+
31
+ // .d-sm-block, .d-md-none, .d-lg-inline
32
+ .d-#{$media-query}-block {
33
+ display: block !important;
34
+ }
35
+ .d-#{$media-query}-flex {
36
+ display: flex !important;
37
+ }
38
+ .d-#{$media-query}-inline {
39
+ display: inline !important;
40
+ }
41
+ .d-#{$media-query}-inline-block {
42
+ display: inline-block !important;
43
+ }
44
+ .d-#{$media-query}-none {
45
+ display: none !important;
46
+ }
47
+ }
48
+ }
49
+ }
50
+
51
+ // Horizontal alignment
52
+
53
+ .float-left {
54
+ float: left !important;
55
+ }
56
+
57
+ .float-right {
58
+ float: right !important;
59
+ }
60
+
61
+ .flex-justify-start {
62
+ justify-content: flex-start !important;
63
+ }
64
+
65
+ .flex-justify-end {
66
+ justify-content: flex-end !important;
67
+ }
68
+
69
+ .flex-justify-between {
70
+ justify-content: space-between !important;
71
+ }
72
+
73
+ .flex-justify-around {
74
+ justify-content: space-around !important;
75
+ }
76
+
77
+ // Vertical alignment
78
+
79
+ .v-align-baseline {
80
+ vertical-align: baseline !important;
81
+ }
82
+
83
+ .v-align-bottom {
84
+ vertical-align: bottom !important;
85
+ }
86
+
87
+ .v-align-middle {
88
+ vertical-align: middle !important;
89
+ }
90
+
91
+ .v-align-text-bottom {
92
+ vertical-align: text-bottom !important;
93
+ }
94
+
95
+ .v-align-text-top {
96
+ vertical-align: text-top !important;
97
+ }
98
+
99
+ .v-align-top {
100
+ vertical-align: top !important;
101
+ }
@@ -0,0 +1,15 @@
1
+ // Utility classes for lists
2
+
3
+ // stylelint-disable selector-max-type
4
+
5
+ .list-style-none {
6
+ padding: 0 !important;
7
+ margin: 0 !important;
8
+ list-style: none !important;
9
+
10
+ li {
11
+ &::before {
12
+ display: none !important;
13
+ }
14
+ }
15
+ }