fni-docs-theme 0.4.2

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 (66) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE.txt +21 -0
  3. data/README.md +19 -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 +39 -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 +31 -0
  14. data/_includes/title.html +5 -0
  15. data/_includes/vendor/anchor_headings.html +144 -0
  16. data/_layouts/about.html +5 -0
  17. data/_layouts/default.html +199 -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 +324 -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/jtd-nav.js +35 -0
  59. data/assets/js/just-the-docs.js +471 -0
  60. data/assets/js/vendor/lunr.min.js +6 -0
  61. data/assets/js/zzzz-search-data.json +72 -0
  62. data/bin/just-the-docs +16 -0
  63. data/lib/fni-docs-theme.rb +1 -0
  64. data/lib/generators/nav-generator.rb +31 -0
  65. data/lib/tasks/search.rake +86 -0
  66. metadata +200 -0
data/_sass/tables.scss ADDED
@@ -0,0 +1,58 @@
1
+ //
2
+ // Tables
3
+ //
4
+ // stylelint-disable max-nesting-depth, selector-no-type, selector-max-type
5
+
6
+ .table-wrapper {
7
+ display: block;
8
+ width: 100%;
9
+ max-width: 100%;
10
+ margin-bottom: $sp-5;
11
+ overflow-x: auto;
12
+ border-radius: $border-radius;
13
+ box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
14
+ }
15
+
16
+ table {
17
+ display: table;
18
+ min-width: 100%;
19
+ border-collapse: separate;
20
+ }
21
+
22
+ th,
23
+ td {
24
+ @include fs-3;
25
+ min-width: 120px;
26
+ padding-top: $sp-2;
27
+ padding-right: $sp-3;
28
+ padding-bottom: $sp-2;
29
+ padding-left: $sp-3;
30
+ background-color: $table-background-color;
31
+ border-bottom: $border rgba($border-color, 0.5);
32
+ border-left: $border $border-color;
33
+
34
+ &:first-of-type {
35
+ border-left: 0;
36
+ }
37
+ }
38
+
39
+ tbody {
40
+ tr {
41
+ &:last-of-type {
42
+ th,
43
+ td {
44
+ border-bottom: 0;
45
+ }
46
+
47
+ td {
48
+ padding-bottom: $sp-3;
49
+ }
50
+ }
51
+ }
52
+ }
53
+
54
+ thead {
55
+ th {
56
+ border-bottom: $border $border-color;
57
+ }
58
+ }
@@ -0,0 +1,64 @@
1
+ //
2
+ // Typography
3
+ //
4
+ // stylelint-disable primer/selector-no-utility, primer/no-override, selector-no-type, selector-max-type
5
+
6
+ h1,
7
+ .text-alpha {
8
+ @include fs-8;
9
+ font-weight: 300;
10
+ }
11
+
12
+ h2,
13
+ .text-beta {
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
+ font-weight: 400;
26
+ text-transform: uppercase;
27
+ letter-spacing: 0.1em;
28
+ }
29
+
30
+ h4 code {
31
+ text-transform: none;
32
+ }
33
+
34
+ h5,
35
+ .text-epsilon {
36
+ @include fs-3;
37
+ color: $grey-dk-200;
38
+ }
39
+
40
+ h6,
41
+ .text-zeta {
42
+ @include fs-2;
43
+ color: $grey-dk-200;
44
+ }
45
+
46
+ .text-small {
47
+ @include fs-2;
48
+ }
49
+
50
+ .text-mono {
51
+ font-family: $mono-font-family !important;
52
+ }
53
+
54
+ .text-left {
55
+ text-align: left !important;
56
+ }
57
+
58
+ .text-center {
59
+ text-align: center !important;
60
+ }
61
+
62
+ .text-right {
63
+ text-align: right !important;
64
+ }
@@ -0,0 +1,239 @@
1
+ //
2
+ // Utility classes for colors
3
+ //
4
+
5
+ // Text colors
6
+
7
+ .text-grey-dk-000 {
8
+ color: $grey-dk-000 !important;
9
+ }
10
+
11
+ .text-grey-dk-100 {
12
+ color: $grey-dk-100 !important;
13
+ }
14
+
15
+ .text-grey-dk-200 {
16
+ color: $grey-dk-200 !important;
17
+ }
18
+
19
+ .text-grey-dk-250 {
20
+ color: $grey-dk-250 !important;
21
+ }
22
+
23
+ .text-grey-dk-300 {
24
+ color: $grey-dk-300 !important;
25
+ }
26
+
27
+ .text-grey-lt-000 {
28
+ color: $grey-lt-000 !important;
29
+ }
30
+
31
+ .text-grey-lt-100 {
32
+ color: $grey-lt-100 !important;
33
+ }
34
+
35
+ .text-grey-lt-200 {
36
+ color: $grey-lt-200 !important;
37
+ }
38
+
39
+ .text-grey-lt-300 {
40
+ color: $grey-lt-300 !important;
41
+ }
42
+
43
+ .text-blue-000 {
44
+ color: $blue-000 !important;
45
+ }
46
+
47
+ .text-blue-100 {
48
+ color: $blue-100 !important;
49
+ }
50
+
51
+ .text-blue-200 {
52
+ color: $blue-200 !important;
53
+ }
54
+
55
+ .text-blue-300 {
56
+ color: $blue-300 !important;
57
+ }
58
+
59
+ .text-green-000 {
60
+ color: $green-000 !important;
61
+ }
62
+
63
+ .text-green-100 {
64
+ color: $green-100 !important;
65
+ }
66
+
67
+ .text-green-200 {
68
+ color: $green-200 !important;
69
+ }
70
+
71
+ .text-green-300 {
72
+ color: $green-300 !important;
73
+ }
74
+
75
+ .text-purple-000 {
76
+ color: $purple-000 !important;
77
+ }
78
+
79
+ .text-purple-100 {
80
+ color: $purple-100 !important;
81
+ }
82
+
83
+ .text-purple-200 {
84
+ color: $purple-200 !important;
85
+ }
86
+
87
+ .text-purple-300 {
88
+ color: $purple-300 !important;
89
+ }
90
+
91
+ .text-yellow-000 {
92
+ color: $yellow-000 !important;
93
+ }
94
+
95
+ .text-yellow-100 {
96
+ color: $yellow-100 !important;
97
+ }
98
+
99
+ .text-yellow-200 {
100
+ color: $yellow-200 !important;
101
+ }
102
+
103
+ .text-yellow-300 {
104
+ color: $yellow-300 !important;
105
+ }
106
+
107
+ .text-red-000 {
108
+ color: $red-000 !important;
109
+ }
110
+
111
+ .text-red-100 {
112
+ color: $red-100 !important;
113
+ }
114
+
115
+ .text-red-200 {
116
+ color: $red-200 !important;
117
+ }
118
+
119
+ .text-red-300 {
120
+ color: $red-300 !important;
121
+ }
122
+
123
+ // Background colors
124
+
125
+ .bg-grey-dk-000 {
126
+ background-color: $grey-dk-000 !important;
127
+ }
128
+
129
+ .bg-grey-dk-100 {
130
+ background-color: $grey-dk-100 !important;
131
+ }
132
+
133
+ .bg-grey-dk-200 {
134
+ background-color: $grey-dk-200 !important;
135
+ }
136
+
137
+ .bg-grey-dk-250 {
138
+ background-color: $grey-dk-250 !important;
139
+ }
140
+
141
+ .bg-grey-dk-300 {
142
+ background-color: $grey-dk-300 !important;
143
+ }
144
+
145
+ .bg-grey-lt-000 {
146
+ background-color: $grey-lt-000 !important;
147
+ }
148
+
149
+ .bg-grey-lt-100 {
150
+ background-color: $grey-lt-100 !important;
151
+ }
152
+
153
+ .bg-grey-lt-200 {
154
+ background-color: $grey-lt-200 !important;
155
+ }
156
+
157
+ .bg-grey-lt-300 {
158
+ background-color: $grey-lt-300 !important;
159
+ }
160
+
161
+ .bg-blue-000 {
162
+ background-color: $blue-000 !important;
163
+ }
164
+
165
+ .bg-blue-100 {
166
+ background-color: $blue-100 !important;
167
+ }
168
+
169
+ .bg-blue-200 {
170
+ background-color: $blue-200 !important;
171
+ }
172
+
173
+ .bg-blue-300 {
174
+ background-color: $blue-300 !important;
175
+ }
176
+
177
+ .bg-green-000 {
178
+ background-color: $green-000 !important;
179
+ }
180
+
181
+ .bg-green-100 {
182
+ background-color: $green-100 !important;
183
+ }
184
+
185
+ .bg-green-200 {
186
+ background-color: $green-200 !important;
187
+ }
188
+
189
+ .bg-green-300 {
190
+ background-color: $green-300 !important;
191
+ }
192
+
193
+ .bg-purple-000 {
194
+ background-color: $purple-000 !important;
195
+ }
196
+
197
+ .bg-purple-100 {
198
+ background-color: $purple-100 !important;
199
+ }
200
+
201
+ .bg-purple-200 {
202
+ background-color: $purple-200 !important;
203
+ }
204
+
205
+ .bg-purple-300 {
206
+ background-color: $purple-300 !important;
207
+ }
208
+
209
+ .bg-yellow-000 {
210
+ background-color: $yellow-000 !important;
211
+ }
212
+
213
+ .bg-yellow-100 {
214
+ background-color: $yellow-100 !important;
215
+ }
216
+
217
+ .bg-yellow-200 {
218
+ background-color: $yellow-200 !important;
219
+ }
220
+
221
+ .bg-yellow-300 {
222
+ background-color: $yellow-300 !important;
223
+ }
224
+
225
+ .bg-red-000 {
226
+ background-color: $red-000 !important;
227
+ }
228
+
229
+ .bg-red-100 {
230
+ background-color: $red-100 !important;
231
+ }
232
+
233
+ .bg-red-200 {
234
+ background-color: $red-200 !important;
235
+ }
236
+
237
+ .bg-red-300 {
238
+ background-color: $red-300 !important;
239
+ }
@@ -0,0 +1,95 @@
1
+ // stylelint-disable primer/selector-no-utility, primer/no-override
2
+ //
3
+ // Utility classes for layout
4
+ //
5
+
6
+ // Display
7
+
8
+ .d-block {
9
+ display: block !important;
10
+ }
11
+ .d-flex {
12
+ display: flex !important;
13
+ }
14
+ .d-inline {
15
+ display: inline !important;
16
+ }
17
+ .d-inline-block {
18
+ display: inline-block !important;
19
+ }
20
+ .d-none {
21
+ display: none !important;
22
+ }
23
+
24
+ @each $media-query in map-keys($media-queries) {
25
+ @for $i from 1 through length($spacers) {
26
+ @include mq($media-query) {
27
+ $size: #{map-get($spacers, sp-#{$i - 1})};
28
+ $scale: #{$i - 1};
29
+
30
+ // .d-sm-block, .d-md-none, .d-lg-inline
31
+ .d-#{$media-query}-block {
32
+ display: block !important;
33
+ }
34
+ .d-#{$media-query}-flex {
35
+ display: flex !important;
36
+ }
37
+ .d-#{$media-query}-inline {
38
+ display: inline !important;
39
+ }
40
+ .d-#{$media-query}-inline-block {
41
+ display: inline-block !important;
42
+ }
43
+ .d-#{$media-query}-none {
44
+ display: none !important;
45
+ }
46
+ }
47
+ }
48
+ }
49
+
50
+ // Horizontal alignment
51
+
52
+ .float-left {
53
+ float: left !important;
54
+ }
55
+
56
+ .float-right {
57
+ float: right !important;
58
+ }
59
+
60
+ .flex-justify-start {
61
+ justify-content: flex-start !important;
62
+ }
63
+
64
+ .flex-justify-end {
65
+ justify-content: flex-end !important;
66
+ }
67
+
68
+ .flex-justify-between {
69
+ justify-content: space-between !important;
70
+ }
71
+
72
+ .flex-justify-around {
73
+ justify-content: space-around !important;
74
+ }
75
+
76
+ // Vertical alignment
77
+
78
+ .v-align-baseline {
79
+ vertical-align: baseline !important;
80
+ }
81
+ .v-align-bottom {
82
+ vertical-align: bottom !important;
83
+ }
84
+ .v-align-middle {
85
+ vertical-align: middle !important;
86
+ }
87
+ .v-align-text-bottom {
88
+ vertical-align: text-bottom !important;
89
+ }
90
+ .v-align-text-top {
91
+ vertical-align: text-top !important;
92
+ }
93
+ .v-align-top {
94
+ vertical-align: top !important;
95
+ }
@@ -0,0 +1,17 @@
1
+ //
2
+ // Utility classes for lists
3
+ //
4
+
5
+ // stylelint-disable primer/selector-no-utility, primer/no-override, selector-max-type
6
+
7
+ .list-style-none {
8
+ padding: 0 !important;
9
+ margin: 0 !important;
10
+ list-style: none !important;
11
+
12
+ li {
13
+ &::before {
14
+ display: none !important;
15
+ }
16
+ }
17
+ }
@@ -0,0 +1,165 @@
1
+ //
2
+ // Utility classes for margins and padding
3
+ //
4
+
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
7
+
8
+ // Margin spacer utilities
9
+
10
+ .mx-auto {
11
+ margin-right: auto !important;
12
+ margin-left: auto !important;
13
+ }
14
+
15
+ @for $i from 1 through length($spacers) {
16
+ $size: #{map-get($spacers, sp-#{$i - 1})};
17
+ $scale: #{$i - 1};
18
+
19
+ // .m-0, .m-1, .m-2...
20
+ .m-#{$scale} {
21
+ margin: #{$size} !important;
22
+ }
23
+ .mt-#{$scale} {
24
+ margin-top: #{$size} !important;
25
+ }
26
+ .mr-#{$scale} {
27
+ margin-right: #{$size} !important;
28
+ }
29
+ .mb-#{$scale} {
30
+ margin-bottom: #{$size} !important;
31
+ }
32
+ .ml-#{$scale} {
33
+ margin-left: #{$size} !important;
34
+ }
35
+
36
+ .mx-#{$scale} {
37
+ margin-right: #{$size} !important;
38
+ margin-left: #{$size} !important;
39
+ }
40
+
41
+ .my-#{$scale} {
42
+ margin-top: #{$size} !important;
43
+ margin-bottom: #{$size} !important;
44
+ }
45
+
46
+ .mxn-#{$scale} {
47
+ margin-right: -#{$size} !important;
48
+ margin-left: -#{$size} !important;
49
+ }
50
+ .mx-#{$scale}-auto {
51
+ margin-right: auto !important;
52
+ margin-left: auto !important;
53
+ }
54
+ }
55
+
56
+ @each $media-query in map-keys($media-queries) {
57
+ @for $i from 1 through length($spacers) {
58
+ @include mq($media-query) {
59
+ $size: #{map-get($spacers, sp-#{$i - 1})};
60
+ $scale: #{$i - 1};
61
+
62
+ // .m-sm-0, .m-md-1, .m-lg-2...
63
+ .m-#{$media-query}-#{$scale} {
64
+ margin: #{$size} !important;
65
+ }
66
+ .mt-#{$media-query}-#{$scale} {
67
+ margin-top: #{$size} !important;
68
+ }
69
+ .mr-#{$media-query}-#{$scale} {
70
+ margin-right: #{$size} !important;
71
+ }
72
+ .mb-#{$media-query}-#{$scale} {
73
+ margin-bottom: #{$size} !important;
74
+ }
75
+ .ml-#{$media-query}-#{$scale} {
76
+ margin-left: #{$size} !important;
77
+ }
78
+
79
+ .mx-#{$media-query}-#{$scale} {
80
+ margin-right: #{$size} !important;
81
+ margin-left: #{$size} !important;
82
+ }
83
+
84
+ .my-#{$media-query}-#{$scale} {
85
+ margin-top: #{$size} !important;
86
+ margin-bottom: #{$size} !important;
87
+ }
88
+
89
+ .mxn-#{$media-query}-#{$scale} {
90
+ margin-right: -#{$size} !important;
91
+ margin-left: -#{$size} !important;
92
+ }
93
+ }
94
+ }
95
+ }
96
+
97
+ // Padding spacer utilities
98
+
99
+ @for $i from 1 through length($spacers) {
100
+ $size: #{map-get($spacers, sp-#{$i - 1})};
101
+ $scale: #{$i - 1};
102
+
103
+ // .p-0, .p-1, .p-2...
104
+ .p-#{$scale} {
105
+ padding: #{$size} !important;
106
+ }
107
+ .pt-#{$scale} {
108
+ padding-top: #{$size} !important;
109
+ }
110
+ .pr-#{$scale} {
111
+ padding-right: #{$size} !important;
112
+ }
113
+ .pb-#{$scale} {
114
+ padding-bottom: #{$size} !important;
115
+ }
116
+ .pl-#{$scale} {
117
+ padding-left: #{$size} !important;
118
+ }
119
+
120
+ .px-#{$scale} {
121
+ padding-right: #{$size} !important;
122
+ padding-left: #{$size} !important;
123
+ }
124
+
125
+ .py-#{$scale} {
126
+ padding-top: #{$size} !important;
127
+ padding-bottom: #{$size} !important;
128
+ }
129
+ }
130
+
131
+ @each $media-query in map-keys($media-queries) {
132
+ @include mq($media-query) {
133
+ @for $i from 1 through length($spacers) {
134
+ $size: #{map-get($spacers, sp-#{$i - 1})};
135
+ $scale: #{$i - 1};
136
+
137
+ // .p-sm-0, .p-md-1, .p-lg-2...
138
+ .p-#{$media-query}-#{$scale} {
139
+ padding: #{$size} !important;
140
+ }
141
+ .pt-#{$media-query}-#{$scale} {
142
+ padding-top: #{$size} !important;
143
+ }
144
+ .pr-#{$media-query}-#{$scale} {
145
+ padding-right: #{$size} !important;
146
+ }
147
+ .pb-#{$media-query}-#{$scale} {
148
+ padding-bottom: #{$size} !important;
149
+ }
150
+ .pl-#{$media-query}-#{$scale} {
151
+ padding-left: #{$size} !important;
152
+ }
153
+
154
+ .px-#{$media-query}-#{$scale} {
155
+ padding-right: #{$size} !important;
156
+ padding-left: #{$size} !important;
157
+ }
158
+
159
+ .py-#{$media-query}-#{$scale} {
160
+ padding-top: #{$size} !important;
161
+ padding-bottom: #{$size} !important;
162
+ }
163
+ }
164
+ }
165
+ }
@@ -0,0 +1,91 @@
1
+ //
2
+ // Utility classes for typography
3
+ //
4
+
5
+ // stylelint-disable primer/selector-no-utility, primer/no-override
6
+
7
+ .fs-1 {
8
+ @include fs-1;
9
+ }
10
+
11
+ .fs-2 {
12
+ @include fs-2;
13
+ }
14
+
15
+ .fs-3 {
16
+ @include fs-3;
17
+ }
18
+
19
+ .fs-4 {
20
+ @include fs-4;
21
+ }
22
+
23
+ .fs-5 {
24
+ @include fs-5;
25
+ }
26
+
27
+ .fs-6 {
28
+ @include fs-6;
29
+ }
30
+
31
+ .fs-7 {
32
+ @include fs-7;
33
+ }
34
+
35
+ .fs-8 {
36
+ @include fs-8;
37
+ }
38
+
39
+ .fs-9 {
40
+ @include fs-9;
41
+ }
42
+
43
+ .fs-10 {
44
+ @include fs-10;
45
+ }
46
+
47
+ .fw-300 {
48
+ font-weight: 300 !important;
49
+ }
50
+
51
+ .fw-400 {
52
+ font-weight: 400 !important;
53
+ }
54
+
55
+ .fw-500 {
56
+ font-weight: 500 !important;
57
+ }
58
+
59
+ .fw-700 {
60
+ font-weight: 700 !important;
61
+ }
62
+
63
+ .lh-0 {
64
+ line-height: 0 !important;
65
+ }
66
+
67
+ .lh-default {
68
+ line-height: $body-line-height;
69
+ }
70
+
71
+ .lh-tight {
72
+ line-height: $body-heading-line-height;
73
+ }
74
+
75
+ .ls-5 {
76
+ letter-spacing: 0.05em !important;
77
+ }
78
+
79
+ .ls-10 {
80
+ letter-spacing: 0.1em !important;
81
+ }
82
+
83
+ .ls-0 {
84
+ letter-spacing: 0 !important;
85
+ }
86
+
87
+ .text-uppercase {
88
+ text-transform: uppercase !important;
89
+ }
90
+
91
+ // stylelint-enable primer/selector-no-utility
@@ -0,0 +1,5 @@
1
+ @import "./colors";
2
+ @import "./layout";
3
+ @import "./typography";
4
+ @import "./lists";
5
+ @import "./spacing";