just-the-docs 0.1.0
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.
- checksums.yaml +7 -0
- data/LICENSE.txt +21 -0
- data/README.md +48 -0
- data/Rakefile +1 -0
- data/_includes/head.html +11 -0
- data/_includes/nav.html +24 -0
- data/_layouts/default.html +68 -0
- data/_layouts/post.html +5 -0
- data/_sass/base.scss +104 -0
- data/_sass/buttons.scss +114 -0
- data/_sass/code.scss +121 -0
- data/_sass/content.scss +64 -0
- data/_sass/custom/custom.scss +112 -0
- data/_sass/labels.scss +35 -0
- data/_sass/layout.scss +121 -0
- data/_sass/navigation.scss +134 -0
- data/_sass/normalize.scss/README.md +78 -0
- data/_sass/normalize.scss/normalize.scss +427 -0
- data/_sass/normalize.scss/package.json +70 -0
- data/_sass/search.scss +88 -0
- data/_sass/support/_functions.scss +10 -0
- data/_sass/support/_variables.scss +122 -0
- data/_sass/support/mixins/_buttons.scss +25 -0
- data/_sass/support/mixins/_layout.scss +34 -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 +77 -0
- data/_sass/typography.scss +54 -0
- data/_sass/utilities/_colors.scss +231 -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/assets/css/just-the-docs.scss +33 -0
- data/assets/images/just-the-docs.png +0 -0
- data/assets/images/search.svg +1 -0
- data/assets/js/just-the-docs.js +150 -0
- data/assets/js/vendor/lunr.min.js +6 -0
- data/bin/just-the-docs +16 -0
- data/lib/tasks/search.rake +22 -0
- metadata +129 -0
data/_sass/content.scss
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
//
|
2
|
+
// Styles for rendered markdown in the .main-content container
|
3
|
+
//
|
4
|
+
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors
|
5
|
+
|
6
|
+
.page-content {
|
7
|
+
ul,
|
8
|
+
ol,
|
9
|
+
dl {
|
10
|
+
padding-left: 1.5em;
|
11
|
+
}
|
12
|
+
|
13
|
+
ol {
|
14
|
+
list-style-type: none;
|
15
|
+
counter-reset: step-counter;
|
16
|
+
|
17
|
+
li {
|
18
|
+
position: relative;
|
19
|
+
|
20
|
+
&::before {
|
21
|
+
position: absolute;
|
22
|
+
top: 0.2em;
|
23
|
+
left: -1.5em;
|
24
|
+
color: $grey-dk-000;
|
25
|
+
content: counter(step-counter);
|
26
|
+
counter-increment: step-counter;
|
27
|
+
@include fs-3;
|
28
|
+
|
29
|
+
@include mq(sm) {
|
30
|
+
top: 0.11em;
|
31
|
+
}
|
32
|
+
}
|
33
|
+
|
34
|
+
ol {
|
35
|
+
counter-reset: sub-counter;
|
36
|
+
|
37
|
+
li {
|
38
|
+
&::before {
|
39
|
+
content: counter(sub-counter, lower-alpha);
|
40
|
+
counter-increment: sub-counter;
|
41
|
+
}
|
42
|
+
}
|
43
|
+
}
|
44
|
+
}
|
45
|
+
}
|
46
|
+
|
47
|
+
ul {
|
48
|
+
list-style: none;
|
49
|
+
|
50
|
+
li {
|
51
|
+
&::before {
|
52
|
+
position: absolute;
|
53
|
+
margin-left: -1.5em;
|
54
|
+
color: $grey-dk-000;
|
55
|
+
content: "•";
|
56
|
+
}
|
57
|
+
}
|
58
|
+
}
|
59
|
+
|
60
|
+
hr + *,
|
61
|
+
h1:first-of-type {
|
62
|
+
margin-top: 0;
|
63
|
+
}
|
64
|
+
}
|
@@ -0,0 +1,112 @@
|
|
1
|
+
// //
|
2
|
+
// // Typography
|
3
|
+
// //
|
4
|
+
//
|
5
|
+
// $body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue", helvetica, roboto, noto, "segoe ui", arial, sans-serif;
|
6
|
+
// $mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace;
|
7
|
+
// $root-font-size: 16px; // Base font-size for rems
|
8
|
+
// $body-line-height: 1.4;
|
9
|
+
// $body-heading-line-height: 1.15;
|
10
|
+
//
|
11
|
+
// //
|
12
|
+
// // Colors
|
13
|
+
// //
|
14
|
+
//
|
15
|
+
// $white: #fff;
|
16
|
+
//
|
17
|
+
// $grey-dk-000: #959396;
|
18
|
+
// $grey-dk-100: #5c5962;
|
19
|
+
// $grey-dk-200: #44434d;
|
20
|
+
// $grey-dk-300: #27262b;
|
21
|
+
//
|
22
|
+
// $grey-lt-000: #f5f6fa;
|
23
|
+
// $grey-lt-100: #eeebee;
|
24
|
+
// $grey-lt-200: #ecebed;
|
25
|
+
// $grey-lt-300: #e6e1e8;
|
26
|
+
//
|
27
|
+
// $purple-000: #7253ed;
|
28
|
+
// $purple-100: #5e41d0;
|
29
|
+
// $purple-200: #4e26af;
|
30
|
+
// $purple-300: #381885;
|
31
|
+
//
|
32
|
+
// $blue-000: #2c84fa;
|
33
|
+
// $blue-100: #2869e6;
|
34
|
+
// $blue-200: #264caf;
|
35
|
+
// $blue-300: #183385;
|
36
|
+
//
|
37
|
+
// $green-000: #41d693;
|
38
|
+
// $green-100: #11b584;
|
39
|
+
// $green-200: #009c7b;
|
40
|
+
// $green-300: #026e57;
|
41
|
+
//
|
42
|
+
// $body-text-color: $grey-dk-100;
|
43
|
+
// $body-heading-color: $grey-dk-300;
|
44
|
+
// $link-color: $purple-000;
|
45
|
+
//
|
46
|
+
// //
|
47
|
+
// // Media queries in pixels
|
48
|
+
// //
|
49
|
+
//
|
50
|
+
// $media-queries: (
|
51
|
+
// xs: 320px,
|
52
|
+
// sm: 500px,
|
53
|
+
// md: 740px,
|
54
|
+
// lg: 1120px,
|
55
|
+
// xl: 1400px
|
56
|
+
// );
|
57
|
+
//
|
58
|
+
// //
|
59
|
+
// // Spacing
|
60
|
+
// //
|
61
|
+
//
|
62
|
+
// $spacing-unit: 1rem; // 1rem == 16px
|
63
|
+
//
|
64
|
+
// $spacers: (
|
65
|
+
// sp-0: 0,
|
66
|
+
// sp-1: $spacing-unit * 0.25,
|
67
|
+
// sp-2: $spacing-unit * 0.5,
|
68
|
+
// sp-3: $spacing-unit * 0.75,
|
69
|
+
// sp-4: $spacing-unit,
|
70
|
+
// sp-5: $spacing-unit * 1.5,
|
71
|
+
// sp-6: $spacing-unit * 2,
|
72
|
+
// sp-7: $spacing-unit * 2.5,
|
73
|
+
// sp-8: $spacing-unit * 3,
|
74
|
+
// sp-9: $spacing-unit * 3.5,
|
75
|
+
// sp-10: $spacing-unit * 4
|
76
|
+
// );
|
77
|
+
//
|
78
|
+
// $sp-1: map-get($spacers, sp-1); // 0.25 rem == 4px
|
79
|
+
// $sp-2: map-get($spacers, sp-2); // 0.5 rem == 8px
|
80
|
+
// $sp-3: map-get($spacers, sp-3); // 0.75 rem == 12px
|
81
|
+
// $sp-4: map-get($spacers, sp-4); // 1 rem == 16px
|
82
|
+
// $sp-5: map-get($spacers, sp-5); // 1.5 rem == 24px
|
83
|
+
// $sp-6: map-get($spacers, sp-6); // 2 rem == 32px
|
84
|
+
// $sp-7: map-get($spacers, sp-7); // 2.5 rem == 40px
|
85
|
+
// $sp-8: map-get($spacers, sp-8); // 3 rem == 48px
|
86
|
+
// $sp-9: map-get($spacers, sp-9); // 4 rem == 48px
|
87
|
+
// $sp-10: map-get($spacers, sp-10); // 4.5 rem == 48px
|
88
|
+
//
|
89
|
+
// //
|
90
|
+
// // Borders
|
91
|
+
// //
|
92
|
+
//
|
93
|
+
// $border: 1px solid;
|
94
|
+
// $border-radius: 4px;
|
95
|
+
// $border-color: $grey-lt-100;
|
96
|
+
//
|
97
|
+
// //
|
98
|
+
// // Grid system
|
99
|
+
// //
|
100
|
+
//
|
101
|
+
// $gutter-spacing: $sp-6;
|
102
|
+
// $gutter-spacing-sm: $sp-4;
|
103
|
+
// $nav-width: 232px;
|
104
|
+
// $content-width: 800px;
|
105
|
+
//
|
106
|
+
// $media-queries: (
|
107
|
+
// xs: 320px,
|
108
|
+
// sm: 500px,
|
109
|
+
// md: 740px,
|
110
|
+
// lg: 800px,
|
111
|
+
// xl: 1316px
|
112
|
+
// );
|
data/_sass/labels.scss
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
//
|
2
|
+
// Labels (not the form kind)
|
3
|
+
//
|
4
|
+
|
5
|
+
.label,
|
6
|
+
.label-blue {
|
7
|
+
display: inline-block;
|
8
|
+
padding-top: 0.16em;
|
9
|
+
padding-right: 0.42em;
|
10
|
+
padding-bottom: 0.16em;
|
11
|
+
padding-left: 0.42em;
|
12
|
+
margin-right: $sp-1;
|
13
|
+
margin-left: $sp-1;
|
14
|
+
color: $white;
|
15
|
+
vertical-align: middle;
|
16
|
+
background-color: $blue-100;
|
17
|
+
@include fs-2;
|
18
|
+
}
|
19
|
+
|
20
|
+
.label-green {
|
21
|
+
background-color: $green-200;
|
22
|
+
}
|
23
|
+
|
24
|
+
.label-purple {
|
25
|
+
background-color: $purple-100;
|
26
|
+
}
|
27
|
+
|
28
|
+
.label-red {
|
29
|
+
background-color: $red-200;
|
30
|
+
}
|
31
|
+
|
32
|
+
.label-yellow {
|
33
|
+
color: $grey-dk-200;
|
34
|
+
background-color: $yellow-200;
|
35
|
+
}
|
data/_sass/layout.scss
ADDED
@@ -0,0 +1,121 @@
|
|
1
|
+
//
|
2
|
+
// The basic two column layout
|
3
|
+
//
|
4
|
+
|
5
|
+
.page-wrap {
|
6
|
+
@include mq(md) {
|
7
|
+
position: absolute;
|
8
|
+
top: 0;
|
9
|
+
left: 0;
|
10
|
+
display: flex;
|
11
|
+
width: 100%;
|
12
|
+
height: 100%;
|
13
|
+
overflow-x: hidden;
|
14
|
+
overflow-y: hidden;
|
15
|
+
}
|
16
|
+
}
|
17
|
+
|
18
|
+
.side-bar {
|
19
|
+
z-index: 100;
|
20
|
+
padding-top: $gutter-spacing-sm;
|
21
|
+
padding-bottom: $gutter-spacing-sm;
|
22
|
+
background-color: $grey-lt-000;
|
23
|
+
|
24
|
+
@include mq(md) {
|
25
|
+
position: absolute;
|
26
|
+
display: flex;
|
27
|
+
width: $nav-width + 16px;
|
28
|
+
height: 100%;
|
29
|
+
padding-top: $gutter-spacing * 2;
|
30
|
+
padding-bottom: 0;
|
31
|
+
flex-direction: column;
|
32
|
+
border-right: $border $border-color;
|
33
|
+
align-items: flex-end;
|
34
|
+
}
|
35
|
+
|
36
|
+
@include mq(lg) {
|
37
|
+
width: calc((100% - #{$nav-width + $content-width}) / 2 + #{$nav-width});
|
38
|
+
min-width: $nav-width;
|
39
|
+
}
|
40
|
+
}
|
41
|
+
|
42
|
+
.main-content-wrap {
|
43
|
+
@include mq(md) {
|
44
|
+
position: absolute;
|
45
|
+
top: 0;
|
46
|
+
left: 0;
|
47
|
+
width: 100%;
|
48
|
+
height: 100%;
|
49
|
+
min-height: 600px;
|
50
|
+
-webkit-overflow-scrolling: touch;
|
51
|
+
overflow-x: hidden;
|
52
|
+
overflow-y: scroll;
|
53
|
+
}
|
54
|
+
}
|
55
|
+
|
56
|
+
.main-content {
|
57
|
+
padding-top: $gutter-spacing-sm;
|
58
|
+
@include container;
|
59
|
+
|
60
|
+
@include mq(md) {
|
61
|
+
position: relative;
|
62
|
+
max-width: $content-width;
|
63
|
+
padding-top: $gutter-spacing;
|
64
|
+
padding-bottom: $gutter-spacing;
|
65
|
+
padding-left: $gutter-spacing * 1.5;
|
66
|
+
margin-left: $nav-width;
|
67
|
+
}
|
68
|
+
|
69
|
+
@include mq(lg) {
|
70
|
+
padding-left: $gutter-spacing;
|
71
|
+
margin-left: calc((100% - #{$nav-width + $content-width}) / 2 + #{$nav-width});
|
72
|
+
}
|
73
|
+
}
|
74
|
+
|
75
|
+
.page-header {
|
76
|
+
background-color: $grey-lt-000;
|
77
|
+
|
78
|
+
@include mq(md) {
|
79
|
+
background-color: $white;
|
80
|
+
border-bottom: $border $border-color;
|
81
|
+
|
82
|
+
}
|
83
|
+
|
84
|
+
.main-content {
|
85
|
+
padding-top: 0;
|
86
|
+
|
87
|
+
@include mq(md) {
|
88
|
+
display: flex;
|
89
|
+
justify-content: space-between;
|
90
|
+
padding-top: $sp-4;
|
91
|
+
}
|
92
|
+
}
|
93
|
+
}
|
94
|
+
|
95
|
+
.navigation,
|
96
|
+
.site-title {
|
97
|
+
|
98
|
+
@include container;
|
99
|
+
|
100
|
+
width: 100%;
|
101
|
+
|
102
|
+
@include mq(lg) {
|
103
|
+
width: $nav-width + 32px;
|
104
|
+
}
|
105
|
+
}
|
106
|
+
|
107
|
+
.navigation {
|
108
|
+
@include mq(md) {
|
109
|
+
position: absolute;
|
110
|
+
top: 0;
|
111
|
+
right: 0;
|
112
|
+
height: 100%;
|
113
|
+
padding-top: $sp-8;
|
114
|
+
}
|
115
|
+
}
|
116
|
+
|
117
|
+
.site-footer {
|
118
|
+
@include mq(md) {
|
119
|
+
margin-top: $sp-10;
|
120
|
+
}
|
121
|
+
}
|
@@ -0,0 +1,134 @@
|
|
1
|
+
//
|
2
|
+
// Main nav, breadcrumb, etc...
|
3
|
+
//
|
4
|
+
|
5
|
+
.site-title {
|
6
|
+
display: block;
|
7
|
+
flex-grow: 1;
|
8
|
+
flex-shrink: 1;
|
9
|
+
flex-basis: auto;
|
10
|
+
background-color: $grey-lt-000;
|
11
|
+
|
12
|
+
@include mq(md) {
|
13
|
+
position: absolute;
|
14
|
+
top: $gutter-spacing;
|
15
|
+
right: 0;
|
16
|
+
z-index: 101;
|
17
|
+
}
|
18
|
+
}
|
19
|
+
|
20
|
+
.navigation-list {
|
21
|
+
padding: 0;
|
22
|
+
margin-top: $sp-4;
|
23
|
+
list-style: none;
|
24
|
+
|
25
|
+
@include mq(md) {
|
26
|
+
margin-top: $sp-10;
|
27
|
+
}
|
28
|
+
}
|
29
|
+
|
30
|
+
.navigation-list-child-list {
|
31
|
+
padding-left: $sp-3;
|
32
|
+
list-style: none;
|
33
|
+
|
34
|
+
.navigation-list-link {
|
35
|
+
color: $grey-dk-100;
|
36
|
+
}
|
37
|
+
|
38
|
+
.navigation-list-item {
|
39
|
+
&::before {
|
40
|
+
position: absolute;
|
41
|
+
margin-top: 0.3em;
|
42
|
+
margin-left: -0.8em;
|
43
|
+
color: $grey-dk-000;
|
44
|
+
content: "- ";
|
45
|
+
}
|
46
|
+
|
47
|
+
&.active {
|
48
|
+
&::before {
|
49
|
+
color: $grey-dk-100;
|
50
|
+
}
|
51
|
+
}
|
52
|
+
}
|
53
|
+
}
|
54
|
+
|
55
|
+
.navigation-list-item {
|
56
|
+
@include fs-3;
|
57
|
+
margin: 0;
|
58
|
+
}
|
59
|
+
|
60
|
+
.navigation-list-link {
|
61
|
+
display: block;
|
62
|
+
padding-top: $sp-1;
|
63
|
+
padding-bottom: $sp-1;
|
64
|
+
|
65
|
+
&.active {
|
66
|
+
font-weight: 600;
|
67
|
+
color: $grey-dk-200;
|
68
|
+
text-decoration: none;
|
69
|
+
}
|
70
|
+
}
|
71
|
+
|
72
|
+
// Small screen nav
|
73
|
+
|
74
|
+
.main-nav,
|
75
|
+
.aux-nav {
|
76
|
+
display: none;
|
77
|
+
|
78
|
+
&.nav-open {
|
79
|
+
display: block;
|
80
|
+
}
|
81
|
+
@include mq(md) {
|
82
|
+
display: block;
|
83
|
+
}
|
84
|
+
}
|
85
|
+
|
86
|
+
.side-bar {
|
87
|
+
display: flex;
|
88
|
+
flex-wrap: wrap;
|
89
|
+
|
90
|
+
@include mq(md) {
|
91
|
+
display: block;
|
92
|
+
overflow-y: auto;
|
93
|
+
}
|
94
|
+
}
|
95
|
+
|
96
|
+
.navigation-list-toggle {
|
97
|
+
position: absolute;
|
98
|
+
right: $sp-4;
|
99
|
+
|
100
|
+
@include mq(md) {
|
101
|
+
display: none !important;
|
102
|
+
}
|
103
|
+
}
|
104
|
+
|
105
|
+
// Breadcrumb nav
|
106
|
+
|
107
|
+
.breadcrumb-nav-list {
|
108
|
+
padding-left: 0;
|
109
|
+
margin-bottom: $sp-3;
|
110
|
+
list-style: none;
|
111
|
+
}
|
112
|
+
|
113
|
+
.breadcrumb-nav-list-item {
|
114
|
+
display: table-cell;
|
115
|
+
@include fs-2;
|
116
|
+
|
117
|
+
&::before {
|
118
|
+
display: none;
|
119
|
+
}
|
120
|
+
|
121
|
+
&::after {
|
122
|
+
display: inline-block;
|
123
|
+
margin-right: $sp-2;
|
124
|
+
margin-left: $sp-2;
|
125
|
+
color: $grey-dk-000;
|
126
|
+
content: "/";
|
127
|
+
}
|
128
|
+
|
129
|
+
&:last-child {
|
130
|
+
&::after {
|
131
|
+
content: "";
|
132
|
+
}
|
133
|
+
}
|
134
|
+
}
|