just-the-docs-altair 0.2.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE.txt +21 -0
- data/README.md +68 -0
- data/Rakefile +1 -0
- data/_includes/head.html +26 -0
- data/_includes/nav.html +44 -0
- data/_layouts/about.html +5 -0
- data/_layouts/default.html +78 -0
- data/_layouts/home.html +5 -0
- data/_layouts/page.html +5 -0
- data/_layouts/post.html +5 -0
- data/_sass/base.scss +110 -0
- data/_sass/buttons.scss +118 -0
- data/_sass/code.scss +122 -0
- data/_sass/color_schemes/dark.scss +14 -0
- data/_sass/content.scss +114 -0
- data/_sass/custom/custom.scss +120 -0
- data/_sass/labels.scss +36 -0
- data/_sass/layout.scss +147 -0
- data/_sass/navigation.scss +148 -0
- data/_sass/search.scss +114 -0
- data/_sass/support/_functions.scss +10 -0
- data/_sass/support/_variables.scss +130 -0
- data/_sass/support/mixins/_buttons.scss +27 -0
- data/_sass/support/mixins/_layout.scss +36 -0
- data/_sass/support/mixins/_typography.scss +81 -0
- data/_sass/support/mixins/mixins.scss +3 -0
- data/_sass/support/support.scss +3 -0
- data/_sass/tables.scss +78 -0
- data/_sass/typography.scss +58 -0
- data/_sass/utilities/_colors.scss +239 -0
- data/_sass/utilities/_layout.scss +38 -0
- data/_sass/utilities/_lists.scss +11 -0
- data/_sass/utilities/_spacing.scss +121 -0
- data/_sass/utilities/_typography.scss +91 -0
- data/_sass/utilities/utilities.scss +5 -0
- data/_sass/vendor/normalize.scss/README.md +78 -0
- data/_sass/vendor/normalize.scss/normalize.scss +427 -0
- data/_sass/vendor/normalize.scss/package.json +70 -0
- data/assets/css/dark-mode-preview.scss +41 -0
- data/assets/css/just-the-docs.scss +44 -0
- data/assets/images/just-the-docs.png +0 -0
- data/assets/images/search.svg +1 -0
- data/assets/js/just-the-docs.js +177 -0
- data/assets/js/search-data.json +12 -0
- data/assets/js/vendor/lunr.min.js +6 -0
- data/bin/just-the-docs +16 -0
- data/lib/tasks/search.rake +27 -0
- metadata +137 -0
@@ -0,0 +1,148 @@
|
|
1
|
+
//
|
2
|
+
// Main nav, breadcrumb, etc...
|
3
|
+
//
|
4
|
+
|
5
|
+
.site-title {
|
6
|
+
display: block;
|
7
|
+
flex: 1 1 auto;
|
8
|
+
color: $body-heading-color;
|
9
|
+
background-color: $sidebar-color;
|
10
|
+
|
11
|
+
@include mq(md) {
|
12
|
+
position: absolute;
|
13
|
+
top: 0;
|
14
|
+
right: 0;
|
15
|
+
z-index: 101;
|
16
|
+
height: 60px;
|
17
|
+
padding-top: $sp-4;
|
18
|
+
border-bottom: $border $border-color;
|
19
|
+
}
|
20
|
+
}
|
21
|
+
|
22
|
+
.navigation-list {
|
23
|
+
padding: 0;
|
24
|
+
margin-top: $sp-4;
|
25
|
+
margin-bottom: 0;
|
26
|
+
list-style: none;
|
27
|
+
|
28
|
+
@include mq(md) {
|
29
|
+
margin-top: 0;
|
30
|
+
}
|
31
|
+
}
|
32
|
+
|
33
|
+
.navigation-list-child-list {
|
34
|
+
padding-left: $sp-3;
|
35
|
+
list-style: none;
|
36
|
+
|
37
|
+
.navigation-list-link {
|
38
|
+
color: $nav-child-link-color;
|
39
|
+
}
|
40
|
+
|
41
|
+
.navigation-list-item {
|
42
|
+
position: relative;
|
43
|
+
|
44
|
+
&::before {
|
45
|
+
position: absolute;
|
46
|
+
margin-top: 0.3em;
|
47
|
+
margin-left: -0.8em;
|
48
|
+
color: rgba($body-text-color, 0.3);
|
49
|
+
content: "- ";
|
50
|
+
}
|
51
|
+
|
52
|
+
&.active {
|
53
|
+
&::before {
|
54
|
+
color: $body-text-color;
|
55
|
+
}
|
56
|
+
}
|
57
|
+
}
|
58
|
+
}
|
59
|
+
|
60
|
+
.navigation-list-item {
|
61
|
+
@include fs-4;
|
62
|
+
margin: 0;
|
63
|
+
|
64
|
+
@include mq(md) {
|
65
|
+
@include fs-3;
|
66
|
+
}
|
67
|
+
|
68
|
+
.navigation-list-child-list {
|
69
|
+
display: none;
|
70
|
+
}
|
71
|
+
|
72
|
+
&.active {
|
73
|
+
.navigation-list-child-list {
|
74
|
+
display: block;
|
75
|
+
}
|
76
|
+
}
|
77
|
+
}
|
78
|
+
|
79
|
+
.navigation-list-link {
|
80
|
+
display: block;
|
81
|
+
padding-top: $sp-1;
|
82
|
+
padding-bottom: $sp-1;
|
83
|
+
|
84
|
+
&.active {
|
85
|
+
font-weight: 600;
|
86
|
+
color: $body-heading-color;
|
87
|
+
text-decoration: none;
|
88
|
+
}
|
89
|
+
}
|
90
|
+
|
91
|
+
// Small screen nav
|
92
|
+
|
93
|
+
.main-nav,
|
94
|
+
.aux-nav {
|
95
|
+
display: none;
|
96
|
+
|
97
|
+
&.nav-open {
|
98
|
+
display: block;
|
99
|
+
}
|
100
|
+
@include mq(md) {
|
101
|
+
display: block;
|
102
|
+
}
|
103
|
+
}
|
104
|
+
|
105
|
+
.navigation-list-toggle {
|
106
|
+
position: absolute;
|
107
|
+
right: $sp-4;
|
108
|
+
|
109
|
+
@include mq(md) {
|
110
|
+
display: none !important;
|
111
|
+
}
|
112
|
+
}
|
113
|
+
|
114
|
+
// Breadcrumb nav
|
115
|
+
.breadcrumb-nav {
|
116
|
+
@include mq(md) {
|
117
|
+
margin-top: -$sp-4;
|
118
|
+
}
|
119
|
+
}
|
120
|
+
|
121
|
+
.breadcrumb-nav-list {
|
122
|
+
padding-left: 0;
|
123
|
+
margin-bottom: $sp-3;
|
124
|
+
list-style: none;
|
125
|
+
}
|
126
|
+
|
127
|
+
.breadcrumb-nav-list-item {
|
128
|
+
display: table-cell;
|
129
|
+
@include fs-2;
|
130
|
+
|
131
|
+
&::before {
|
132
|
+
display: none;
|
133
|
+
}
|
134
|
+
|
135
|
+
&::after {
|
136
|
+
display: inline-block;
|
137
|
+
margin-right: $sp-2;
|
138
|
+
margin-left: $sp-2;
|
139
|
+
color: $grey-dk-000;
|
140
|
+
content: "/";
|
141
|
+
}
|
142
|
+
|
143
|
+
&:last-child {
|
144
|
+
&::after {
|
145
|
+
content: "";
|
146
|
+
}
|
147
|
+
}
|
148
|
+
}
|
data/_sass/search.scss
ADDED
@@ -0,0 +1,114 @@
|
|
1
|
+
//
|
2
|
+
// Search input and autocomplete
|
3
|
+
//
|
4
|
+
|
5
|
+
.search {
|
6
|
+
position: relative;
|
7
|
+
z-index: 99;
|
8
|
+
display: none;
|
9
|
+
flex-grow: 1;
|
10
|
+
padding: $sp-2;
|
11
|
+
margin-bottom: $sp-3;
|
12
|
+
background-color: $white;
|
13
|
+
border-radius: 3px;
|
14
|
+
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.07), 0 3px 10px rgba(0, 0, 0, 0.05);
|
15
|
+
|
16
|
+
@include mq(md) {
|
17
|
+
display: block;
|
18
|
+
padding-top: $sp-1;
|
19
|
+
padding-right: 0;
|
20
|
+
padding-bottom: 0;
|
21
|
+
padding-left: 0;
|
22
|
+
margin-bottom: 0;
|
23
|
+
background-color: transparent;
|
24
|
+
box-shadow: none;
|
25
|
+
}
|
26
|
+
|
27
|
+
&.nav-open {
|
28
|
+
display: block;
|
29
|
+
}
|
30
|
+
}
|
31
|
+
|
32
|
+
.search-results-wrap {
|
33
|
+
display: none;
|
34
|
+
|
35
|
+
&.active {
|
36
|
+
position: absolute;
|
37
|
+
top: $sp-1;
|
38
|
+
z-index: 100;
|
39
|
+
display: block;
|
40
|
+
width: 300px;
|
41
|
+
margin-top: $gutter-spacing;
|
42
|
+
background: lighten($body-background-color, 1%);
|
43
|
+
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.07), 0 4px 14px rgba(0, 0, 0, 0.05);
|
44
|
+
}
|
45
|
+
}
|
46
|
+
|
47
|
+
.search-input-wrap {
|
48
|
+
display: flex;
|
49
|
+
background-color: $body-background-color;
|
50
|
+
}
|
51
|
+
|
52
|
+
.search-input {
|
53
|
+
width: 100%;
|
54
|
+
padding-top: $sp-1;
|
55
|
+
padding-bottom: $sp-1;
|
56
|
+
background-color: $body-background-color;
|
57
|
+
border-top: 0;
|
58
|
+
border-right: 0;
|
59
|
+
border-bottom: 0;
|
60
|
+
border-left: 0;
|
61
|
+
order: 2;
|
62
|
+
|
63
|
+
&:focus {
|
64
|
+
outline: 0;
|
65
|
+
box-shadow: none;
|
66
|
+
|
67
|
+
+ .search-icon {
|
68
|
+
fill: $link-color;
|
69
|
+
}
|
70
|
+
}
|
71
|
+
|
72
|
+
@include fs-5;
|
73
|
+
|
74
|
+
@include mq(sm) {
|
75
|
+
@include fs-3;
|
76
|
+
}
|
77
|
+
|
78
|
+
@include mq(md) {
|
79
|
+
@include fs-2;
|
80
|
+
}
|
81
|
+
}
|
82
|
+
|
83
|
+
.search-icon {
|
84
|
+
align-self: center;
|
85
|
+
margin-right: $sp-2;
|
86
|
+
fill: $grey-dk-000;
|
87
|
+
order: 1;
|
88
|
+
}
|
89
|
+
|
90
|
+
.search-results-list {
|
91
|
+
padding-left: 0;
|
92
|
+
margin-top: $sp-1;
|
93
|
+
margin-bottom: $sp-1;
|
94
|
+
list-style: none;
|
95
|
+
@include fs-3;
|
96
|
+
}
|
97
|
+
|
98
|
+
.search-results-list-item {
|
99
|
+
padding: 0;
|
100
|
+
margin: 0;
|
101
|
+
}
|
102
|
+
|
103
|
+
.search-results-link {
|
104
|
+
display: block;
|
105
|
+
padding-top: $sp-1;
|
106
|
+
padding-right: $sp-3;
|
107
|
+
padding-bottom: $sp-1;
|
108
|
+
padding-left: $sp-3;
|
109
|
+
|
110
|
+
&:hover {
|
111
|
+
color: $body-heading-color;
|
112
|
+
background-color: darken($body-background-color, 2%);
|
113
|
+
}
|
114
|
+
}
|
@@ -0,0 +1,130 @@
|
|
1
|
+
//
|
2
|
+
// Typography
|
3
|
+
//
|
4
|
+
|
5
|
+
$body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue", helvetica, roboto, noto, "segoe ui", arial, sans-serif !default;
|
6
|
+
$mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace !default;
|
7
|
+
$root-font-size: 16px !default; // Base font-size for rems
|
8
|
+
$body-line-height: 1.4 !default;
|
9
|
+
$body-heading-line-height: 1.15 !default !default;
|
10
|
+
|
11
|
+
//
|
12
|
+
// Colors
|
13
|
+
//
|
14
|
+
|
15
|
+
$white: #fff !default;
|
16
|
+
|
17
|
+
$grey-dk-000: #959396 !default;
|
18
|
+
$grey-dk-100: #5c5962 !default;
|
19
|
+
$grey-dk-200: #44434d !default;
|
20
|
+
$grey-dk-250: #302d36 !default;
|
21
|
+
$grey-dk-300: #27262b !default;
|
22
|
+
|
23
|
+
$grey-lt-000: #f5f6fa !default;
|
24
|
+
$grey-lt-100: #eeebee !default;
|
25
|
+
$grey-lt-200: #ecebed !default;
|
26
|
+
$grey-lt-300: #e6e1e8 !default;
|
27
|
+
|
28
|
+
$purple-000: #7253ed !default;
|
29
|
+
$purple-100: #5e41d0 !default;
|
30
|
+
$purple-200: #4e26af !default;
|
31
|
+
$purple-300: #381885 !default;
|
32
|
+
|
33
|
+
$blue-000: #2c84fa !default;
|
34
|
+
$blue-100: #2869e6 !default;
|
35
|
+
$blue-200: #264caf !default;
|
36
|
+
$blue-300: #183385 !default;
|
37
|
+
|
38
|
+
$green-000: #41d693 !default;
|
39
|
+
$green-100: #11b584 !default;
|
40
|
+
$green-200: #009c7b !default;
|
41
|
+
$green-300: #026e57 !default;
|
42
|
+
|
43
|
+
$yellow-000: #ffeb82 !default;
|
44
|
+
$yellow-100: #fadf50 !default;
|
45
|
+
$yellow-200: #f7d12e !default;
|
46
|
+
$yellow-300: #e7af06 !default;
|
47
|
+
|
48
|
+
$red-000: #f77e7e !default;
|
49
|
+
$red-100: #f96e65 !default;
|
50
|
+
$red-200: #e94c4c !default;
|
51
|
+
$red-300: #dd2e2e !default;
|
52
|
+
|
53
|
+
$body-background-color: $white !default;
|
54
|
+
$sidebar-color: $grey-lt-000 !default;
|
55
|
+
$code-background-color: $grey-lt-000 !default;
|
56
|
+
|
57
|
+
$body-text-color: $grey-dk-100 !default;
|
58
|
+
$body-heading-color: $grey-dk-300 !default;
|
59
|
+
$nav-child-link-color: $grey-dk-100 !default;
|
60
|
+
$link-color: $purple-000 !default;
|
61
|
+
$btn-primary-color: $purple-100 !default;
|
62
|
+
$base-button-color: #f7f7f7 !default;
|
63
|
+
|
64
|
+
//
|
65
|
+
// Media queries in pixels
|
66
|
+
//
|
67
|
+
|
68
|
+
$media-queries: (
|
69
|
+
xs: 320px,
|
70
|
+
sm: 500px,
|
71
|
+
md: 740px,
|
72
|
+
lg: 1120px,
|
73
|
+
xl: 1400px
|
74
|
+
) !default;
|
75
|
+
|
76
|
+
//
|
77
|
+
// Spacing
|
78
|
+
//
|
79
|
+
|
80
|
+
$spacing-unit: 1rem; // 1rem == 16px
|
81
|
+
|
82
|
+
$spacers: (
|
83
|
+
sp-0: 0,
|
84
|
+
sp-1: $spacing-unit * 0.25,
|
85
|
+
sp-2: $spacing-unit * 0.5,
|
86
|
+
sp-3: $spacing-unit * 0.75,
|
87
|
+
sp-4: $spacing-unit,
|
88
|
+
sp-5: $spacing-unit * 1.5,
|
89
|
+
sp-6: $spacing-unit * 2,
|
90
|
+
sp-7: $spacing-unit * 2.5,
|
91
|
+
sp-8: $spacing-unit * 3,
|
92
|
+
sp-9: $spacing-unit * 3.5,
|
93
|
+
sp-10: $spacing-unit * 4
|
94
|
+
) !default;
|
95
|
+
|
96
|
+
$sp-1: map-get($spacers, sp-1) !default; // 0.25 rem == 4px
|
97
|
+
$sp-2: map-get($spacers, sp-2) !default; // 0.5 rem == 8px
|
98
|
+
$sp-3: map-get($spacers, sp-3) !default; // 0.75 rem == 12px
|
99
|
+
$sp-4: map-get($spacers, sp-4) !default; // 1 rem == 16px
|
100
|
+
$sp-5: map-get($spacers, sp-5) !default; // 1.5 rem == 24px
|
101
|
+
$sp-6: map-get($spacers, sp-6) !default; // 2 rem == 32px
|
102
|
+
$sp-7: map-get($spacers, sp-7) !default; // 2.5 rem == 40px
|
103
|
+
$sp-8: map-get($spacers, sp-8) !default; // 3 rem == 48px
|
104
|
+
$sp-9: map-get($spacers, sp-9) !default; // 4 rem == 48px
|
105
|
+
$sp-10: map-get($spacers, sp-10) !default; // 4.5 rem == 48px
|
106
|
+
|
107
|
+
//
|
108
|
+
// Borders
|
109
|
+
//
|
110
|
+
|
111
|
+
$border: 1px solid !default;
|
112
|
+
$border-radius: 4px !default;
|
113
|
+
$border-color: $grey-lt-100 !default;
|
114
|
+
|
115
|
+
//
|
116
|
+
// Grid system
|
117
|
+
//
|
118
|
+
|
119
|
+
$gutter-spacing: $sp-6 !default;
|
120
|
+
$gutter-spacing-sm: $sp-4 !default;
|
121
|
+
$nav-width: 232px !default;
|
122
|
+
$content-width: 800px !default;
|
123
|
+
|
124
|
+
$media-queries: (
|
125
|
+
xs: 320px,
|
126
|
+
sm: 500px,
|
127
|
+
md: 740px,
|
128
|
+
lg: 800px,
|
129
|
+
xl: 1316px
|
130
|
+
) !default;
|
@@ -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,36 @@
|
|
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 != null {
|
14
|
+
// Prints a media query based on the value
|
15
|
+
@media (min-width: rem($value)) {
|
16
|
+
@content;
|
17
|
+
}
|
18
|
+
}
|
19
|
+
|
20
|
+
@else {
|
21
|
+
@warn "No value could be retrieved from `#{$media-query}`. "
|
22
|
+
+ "Please make sure it is defined in `$media-queries` map.";
|
23
|
+
}
|
24
|
+
}
|
25
|
+
|
26
|
+
// Responsive container
|
27
|
+
|
28
|
+
@mixin container {
|
29
|
+
padding-right: $gutter-spacing-sm;
|
30
|
+
padding-left: $gutter-spacing-sm;
|
31
|
+
|
32
|
+
@include mq(md) {
|
33
|
+
padding-right: $gutter-spacing;
|
34
|
+
padding-left: $gutter-spacing;
|
35
|
+
}
|
36
|
+
}
|