just-the-docs-peter 0.1.0 → 0.1.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +1508 -0
- data/LICENSE.txt +21 -0
- data/README.md +110 -0
- data/Rakefile +1 -0
- data/_includes/components/aux_nav.html +15 -0
- data/_includes/components/breadcrumbs.html +43 -0
- data/_includes/components/children_nav.html +33 -0
- data/_includes/components/footer.html +34 -0
- data/_includes/components/header.html +11 -0
- data/_includes/components/mermaid.html +45 -0
- data/_includes/components/search_footer.html +7 -0
- data/_includes/components/search_header.html +9 -0
- data/_includes/components/sidebar.html +71 -0
- data/_includes/css/callouts.scss.liquid +93 -0
- data/_includes/css/custom.scss.liquid +1 -0
- data/_includes/css/just-the-docs.scss.liquid +12 -0
- data/_includes/fix_linenos.html +65 -0
- data/_includes/footer_custom.html +3 -0
- data/_includes/head.html +42 -0
- data/_includes/head_custom.html +0 -0
- data/_includes/header_custom.html +0 -0
- data/_includes/icons/code_copy.html +15 -0
- data/_includes/icons/document.html +6 -0
- data/_includes/icons/expand.html +6 -0
- data/_includes/icons/external_link.html +5 -0
- data/_includes/icons/icons.html +13 -0
- data/_includes/icons/link.html +6 -0
- data/_includes/icons/menu.html +6 -0
- data/_includes/icons/search.html +6 -0
- data/_includes/js/custom.js +0 -0
- data/_includes/lunr/custom-data.json +0 -0
- data/_includes/lunr/custom-index.js +0 -0
- data/_includes/mermaid_config.js +1 -0
- data/_includes/nav.html +106 -0
- data/_includes/nav_footer_custom.html +0 -0
- data/_includes/search_placeholder_custom.html +1 -0
- data/_includes/sorted_pages.html +95 -0
- data/_includes/title.html +5 -0
- data/_includes/toc_heading_custom.html +1 -0
- data/_includes/vendor/anchor_headings.html +172 -0
- data/_layouts/about.html +5 -0
- data/_layouts/default.html +41 -0
- data/_layouts/home.html +5 -0
- data/_layouts/minimal.html +34 -0
- data/_layouts/page.html +5 -0
- data/_layouts/post.html +5 -0
- data/_layouts/table_wrappers.html +7 -0
- data/_layouts/vendor/compress.html +10 -0
- data/_sass/base.scss +109 -0
- data/_sass/buttons.scss +123 -0
- data/_sass/code.scss +246 -0
- data/_sass/color_schemes/dark.scss +17 -0
- data/_sass/color_schemes/legacy_light.scss +208 -0
- data/_sass/color_schemes/light.scss +15 -0
- data/_sass/color_schemes/light_peter.scss +15 -0
- data/_sass/content.scss +239 -0
- data/_sass/custom/custom.scss +1 -0
- data/_sass/custom/setup.scss +1 -0
- data/_sass/labels.scss +33 -0
- data/_sass/layout.scss +209 -0
- data/_sass/modules.scss +17 -0
- data/_sass/navigation.scss +235 -0
- data/_sass/print.scss +40 -0
- data/_sass/search.scss +311 -0
- data/_sass/skiptomain.scss +30 -0
- data/_sass/support/_variables.scss +116 -0
- data/_sass/support/mixins/_buttons.scss +27 -0
- data/_sass/support/mixins/_layout.scss +33 -0
- data/_sass/support/mixins/_typography.scss +84 -0
- data/_sass/support/mixins/mixins.scss +3 -0
- data/_sass/support/support.scss +2 -0
- data/_sass/tables.scss +54 -0
- data/_sass/typography.scss +63 -0
- data/_sass/utilities/_colors.scss +237 -0
- data/_sass/utilities/_layout.scss +101 -0
- data/_sass/utilities/_lists.scss +15 -0
- data/_sass/utilities/_spacing.scss +162 -0
- data/_sass/utilities/_typography.scss +85 -0
- data/_sass/utilities/utilities.scss +5 -0
- data/_sass/vendor/OneDarkJekyll/LICENSE +21 -0
- data/_sass/vendor/OneDarkJekyll/syntax.scss +202 -0
- data/_sass/vendor/OneLightJekyll/LICENSE +65 -0
- data/_sass/vendor/OneLightJekyll/syntax.scss +208 -0
- data/_sass/vendor/normalize.scss/README.md +7 -0
- data/_sass/vendor/normalize.scss/normalize.scss +351 -0
- data/assets/css/just-the-docs-dark.scss +3 -0
- data/assets/css/just-the-docs-default.scss +8 -0
- data/assets/css/just-the-docs-light.scss +3 -0
- data/assets/js/just-the-docs.js +535 -0
- data/assets/js/vendor/lunr.min.js +61 -0
- data/assets/js/zzzz-search-data.json +74 -0
- data/bin/just-the-docs +16 -0
- data/favicon.ico +0 -0
- data/lib/tasks/search.rake +88 -0
- metadata +152 -11
@@ -0,0 +1,15 @@
|
|
1
|
+
$body-background-color: $white !default;
|
2
|
+
$body-heading-color: $grey-dk-300 !default;
|
3
|
+
$body-text-color: $grey-dk-100 !default;
|
4
|
+
$link-color: $blue-000;
|
5
|
+
$nav-child-link-color: $grey-dk-100 !default;
|
6
|
+
$sidebar-color: $grey-lt-000 !default;
|
7
|
+
$base-button-color: #f7f7f7 !default;
|
8
|
+
$btn-primary-color: $blue-100;
|
9
|
+
$code-background-color: $grey-lt-000 !default;
|
10
|
+
$feedback-color: darken($sidebar-color, 3%) !default;
|
11
|
+
$table-background-color: $white !default;
|
12
|
+
$search-background-color: $white !default;
|
13
|
+
$search-result-preview-color: $grey-dk-000 !default;
|
14
|
+
|
15
|
+
@import "./vendor/OneLightJekyll/syntax";
|
data/_sass/content.scss
ADDED
@@ -0,0 +1,239 @@
|
|
1
|
+
@charset "UTF-8";
|
2
|
+
|
3
|
+
// Styles for rendered markdown in the .main-content container
|
4
|
+
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type, selector-max-specificity, selector-max-id
|
5
|
+
|
6
|
+
.main-content {
|
7
|
+
line-height: $content-line-height;
|
8
|
+
|
9
|
+
ol,
|
10
|
+
ul,
|
11
|
+
dl,
|
12
|
+
pre,
|
13
|
+
address,
|
14
|
+
blockquote,
|
15
|
+
.table-wrapper {
|
16
|
+
margin-top: 0.5em;
|
17
|
+
}
|
18
|
+
|
19
|
+
a {
|
20
|
+
overflow: hidden;
|
21
|
+
text-overflow: ellipsis;
|
22
|
+
}
|
23
|
+
|
24
|
+
ul,
|
25
|
+
ol {
|
26
|
+
padding-left: 1.5em;
|
27
|
+
}
|
28
|
+
|
29
|
+
li {
|
30
|
+
.highlight {
|
31
|
+
margin-top: $sp-1;
|
32
|
+
}
|
33
|
+
}
|
34
|
+
|
35
|
+
ol {
|
36
|
+
list-style-type: none;
|
37
|
+
counter-reset: step-counter;
|
38
|
+
|
39
|
+
> li {
|
40
|
+
position: relative;
|
41
|
+
|
42
|
+
&::before {
|
43
|
+
position: absolute;
|
44
|
+
top: 0.2em;
|
45
|
+
left: -1.6em;
|
46
|
+
color: $grey-dk-000;
|
47
|
+
content: counter(step-counter);
|
48
|
+
counter-increment: step-counter;
|
49
|
+
@include fs-3;
|
50
|
+
|
51
|
+
@include mq(sm) {
|
52
|
+
top: 0.11em;
|
53
|
+
}
|
54
|
+
}
|
55
|
+
|
56
|
+
ol {
|
57
|
+
counter-reset: sub-counter;
|
58
|
+
|
59
|
+
> li {
|
60
|
+
&::before {
|
61
|
+
content: counter(sub-counter, lower-alpha);
|
62
|
+
counter-increment: sub-counter;
|
63
|
+
}
|
64
|
+
}
|
65
|
+
}
|
66
|
+
}
|
67
|
+
}
|
68
|
+
|
69
|
+
ul {
|
70
|
+
list-style: none;
|
71
|
+
|
72
|
+
> li {
|
73
|
+
&::before {
|
74
|
+
position: absolute;
|
75
|
+
margin-left: -1.4em;
|
76
|
+
color: $grey-dk-000;
|
77
|
+
content: "•";
|
78
|
+
}
|
79
|
+
}
|
80
|
+
}
|
81
|
+
|
82
|
+
.task-list-item {
|
83
|
+
&::before {
|
84
|
+
content: "";
|
85
|
+
}
|
86
|
+
}
|
87
|
+
|
88
|
+
.task-list-item-checkbox {
|
89
|
+
margin-right: 0.6em;
|
90
|
+
margin-left: -1.4em;
|
91
|
+
|
92
|
+
// The same margin-left is used above for ul > li::before
|
93
|
+
}
|
94
|
+
|
95
|
+
hr + * {
|
96
|
+
margin-top: 0;
|
97
|
+
}
|
98
|
+
|
99
|
+
h1:first-of-type {
|
100
|
+
margin-top: 0.5em;
|
101
|
+
}
|
102
|
+
|
103
|
+
dl {
|
104
|
+
display: grid;
|
105
|
+
grid-template: auto / 10em 1fr;
|
106
|
+
}
|
107
|
+
|
108
|
+
dt,
|
109
|
+
dd {
|
110
|
+
margin: 0.25em 0;
|
111
|
+
}
|
112
|
+
|
113
|
+
dt {
|
114
|
+
grid-column: 1;
|
115
|
+
font-weight: 500;
|
116
|
+
text-align: right;
|
117
|
+
|
118
|
+
&::after {
|
119
|
+
content: ":";
|
120
|
+
}
|
121
|
+
}
|
122
|
+
|
123
|
+
dd {
|
124
|
+
grid-column: 2;
|
125
|
+
margin-bottom: 0;
|
126
|
+
margin-left: 1em;
|
127
|
+
|
128
|
+
blockquote,
|
129
|
+
div,
|
130
|
+
dl,
|
131
|
+
dt,
|
132
|
+
h1,
|
133
|
+
h2,
|
134
|
+
h3,
|
135
|
+
h4,
|
136
|
+
h5,
|
137
|
+
h6,
|
138
|
+
li,
|
139
|
+
ol,
|
140
|
+
p,
|
141
|
+
pre,
|
142
|
+
table,
|
143
|
+
ul,
|
144
|
+
.table-wrapper {
|
145
|
+
&:first-child {
|
146
|
+
margin-top: 0;
|
147
|
+
}
|
148
|
+
}
|
149
|
+
}
|
150
|
+
|
151
|
+
dd,
|
152
|
+
ol,
|
153
|
+
ul {
|
154
|
+
dl:first-child {
|
155
|
+
dt:first-child,
|
156
|
+
dd:nth-child(2) {
|
157
|
+
margin-top: 0;
|
158
|
+
}
|
159
|
+
}
|
160
|
+
}
|
161
|
+
|
162
|
+
.anchor-heading {
|
163
|
+
position: absolute;
|
164
|
+
right: -$sp-4;
|
165
|
+
width: $sp-5;
|
166
|
+
height: 100%;
|
167
|
+
padding-right: $sp-1;
|
168
|
+
padding-left: $sp-1;
|
169
|
+
overflow: visible;
|
170
|
+
|
171
|
+
@include mq(md) {
|
172
|
+
right: auto;
|
173
|
+
left: -$sp-5;
|
174
|
+
}
|
175
|
+
|
176
|
+
svg {
|
177
|
+
display: inline-block;
|
178
|
+
width: 100%;
|
179
|
+
height: 100%;
|
180
|
+
color: $link-color;
|
181
|
+
visibility: hidden;
|
182
|
+
}
|
183
|
+
}
|
184
|
+
|
185
|
+
.anchor-heading:hover,
|
186
|
+
.anchor-heading:focus,
|
187
|
+
h1:hover > .anchor-heading,
|
188
|
+
h2:hover > .anchor-heading,
|
189
|
+
h3:hover > .anchor-heading,
|
190
|
+
h4:hover > .anchor-heading,
|
191
|
+
h5:hover > .anchor-heading,
|
192
|
+
h6:hover > .anchor-heading {
|
193
|
+
svg {
|
194
|
+
visibility: visible;
|
195
|
+
}
|
196
|
+
}
|
197
|
+
|
198
|
+
summary {
|
199
|
+
cursor: pointer;
|
200
|
+
}
|
201
|
+
|
202
|
+
h1,
|
203
|
+
h2,
|
204
|
+
h3,
|
205
|
+
h4,
|
206
|
+
h5,
|
207
|
+
h6,
|
208
|
+
#toctitle {
|
209
|
+
position: relative;
|
210
|
+
margin-top: 1.5em;
|
211
|
+
margin-bottom: 0.25em;
|
212
|
+
|
213
|
+
+ table,
|
214
|
+
+ .table-wrapper,
|
215
|
+
+ .code-example,
|
216
|
+
+ .highlighter-rouge,
|
217
|
+
+ .sectionbody .listingblock {
|
218
|
+
margin-top: 1em;
|
219
|
+
}
|
220
|
+
|
221
|
+
+ p:not(.label) {
|
222
|
+
margin-top: 0;
|
223
|
+
}
|
224
|
+
}
|
225
|
+
|
226
|
+
> h1:first-child,
|
227
|
+
> h2:first-child,
|
228
|
+
> h3:first-child,
|
229
|
+
> h4:first-child,
|
230
|
+
> h5:first-child,
|
231
|
+
> h6:first-child,
|
232
|
+
> .sect1:first-child > h2,
|
233
|
+
> .sect2:first-child > h3,
|
234
|
+
> .sect3:first-child > h4,
|
235
|
+
> .sect4:first-child > h5,
|
236
|
+
> .sect5:first-child > h6 {
|
237
|
+
margin-top: $sp-2;
|
238
|
+
}
|
239
|
+
}
|
@@ -0,0 +1 @@
|
|
1
|
+
// custom SCSS (or CSS) goes here
|
@@ -0,0 +1 @@
|
|
1
|
+
// custom setup code goes here
|
data/_sass/labels.scss
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
// Labels (not the form kind)
|
2
|
+
|
3
|
+
.label,
|
4
|
+
.label-blue {
|
5
|
+
display: inline-block;
|
6
|
+
padding: 0.16em 0.56em;
|
7
|
+
margin-right: $sp-2;
|
8
|
+
margin-left: $sp-2;
|
9
|
+
color: $white;
|
10
|
+
text-transform: uppercase;
|
11
|
+
vertical-align: middle;
|
12
|
+
background-color: $blue-100;
|
13
|
+
@include fs-2;
|
14
|
+
|
15
|
+
border-radius: 12px;
|
16
|
+
}
|
17
|
+
|
18
|
+
.label-green {
|
19
|
+
background-color: $green-200;
|
20
|
+
}
|
21
|
+
|
22
|
+
.label-purple {
|
23
|
+
background-color: $purple-100;
|
24
|
+
}
|
25
|
+
|
26
|
+
.label-red {
|
27
|
+
background-color: $red-200;
|
28
|
+
}
|
29
|
+
|
30
|
+
.label-yellow {
|
31
|
+
color: $grey-dk-200;
|
32
|
+
background-color: $yellow-200;
|
33
|
+
}
|
data/_sass/layout.scss
ADDED
@@ -0,0 +1,209 @@
|
|
1
|
+
// The basic two column layout
|
2
|
+
|
3
|
+
.side-bar {
|
4
|
+
z-index: 0;
|
5
|
+
display: flex;
|
6
|
+
flex-wrap: wrap;
|
7
|
+
background-color: $sidebar-color;
|
8
|
+
|
9
|
+
@include mq(md) {
|
10
|
+
flex-flow: column nowrap;
|
11
|
+
position: fixed;
|
12
|
+
width: $nav-width-md;
|
13
|
+
height: 100%;
|
14
|
+
border-right: $border $border-color;
|
15
|
+
align-items: flex-end;
|
16
|
+
}
|
17
|
+
|
18
|
+
@include mq(lg) {
|
19
|
+
width: calc((100% - #{$nav-width + $content-width}) / 2 + #{$nav-width});
|
20
|
+
min-width: $nav-width;
|
21
|
+
}
|
22
|
+
}
|
23
|
+
|
24
|
+
.main {
|
25
|
+
@include mq(md) {
|
26
|
+
position: relative;
|
27
|
+
max-width: $content-width;
|
28
|
+
margin-left: $nav-width-md;
|
29
|
+
}
|
30
|
+
|
31
|
+
@include mq(lg) {
|
32
|
+
// stylelint-disable function-name-case
|
33
|
+
// disable for Max(), we want to use the CSS max() function
|
34
|
+
margin-left: Max(
|
35
|
+
#{$nav-width},
|
36
|
+
calc((100% - #{$nav-width + $content-width}) / 2 + #{$nav-width})
|
37
|
+
);
|
38
|
+
// stylelint-enable function-name-case
|
39
|
+
}
|
40
|
+
}
|
41
|
+
|
42
|
+
.main-content-wrap {
|
43
|
+
@include container;
|
44
|
+
|
45
|
+
padding-top: $gutter-spacing-sm;
|
46
|
+
padding-bottom: $gutter-spacing-sm;
|
47
|
+
|
48
|
+
@include mq(md) {
|
49
|
+
padding-top: $gutter-spacing;
|
50
|
+
padding-bottom: $gutter-spacing;
|
51
|
+
}
|
52
|
+
}
|
53
|
+
|
54
|
+
.main-header {
|
55
|
+
z-index: 0;
|
56
|
+
display: none;
|
57
|
+
background-color: $sidebar-color;
|
58
|
+
|
59
|
+
@include mq(md) {
|
60
|
+
display: flex;
|
61
|
+
justify-content: space-between;
|
62
|
+
height: $header-height;
|
63
|
+
background-color: $body-background-color;
|
64
|
+
border-bottom: $border $border-color;
|
65
|
+
}
|
66
|
+
|
67
|
+
&.nav-open {
|
68
|
+
display: block;
|
69
|
+
|
70
|
+
@include mq(md) {
|
71
|
+
display: flex;
|
72
|
+
}
|
73
|
+
}
|
74
|
+
}
|
75
|
+
|
76
|
+
.site-nav,
|
77
|
+
.site-header,
|
78
|
+
.site-footer {
|
79
|
+
width: 100%;
|
80
|
+
|
81
|
+
@include mq(lg) {
|
82
|
+
width: $nav-width;
|
83
|
+
}
|
84
|
+
}
|
85
|
+
|
86
|
+
.site-nav {
|
87
|
+
display: none;
|
88
|
+
|
89
|
+
&.nav-open {
|
90
|
+
display: block;
|
91
|
+
}
|
92
|
+
|
93
|
+
@include mq(md) {
|
94
|
+
display: block;
|
95
|
+
padding-top: $sp-8;
|
96
|
+
padding-bottom: $gutter-spacing-sm;
|
97
|
+
overflow-y: auto;
|
98
|
+
flex: 1 1 auto;
|
99
|
+
}
|
100
|
+
}
|
101
|
+
|
102
|
+
.site-header {
|
103
|
+
display: flex;
|
104
|
+
min-height: $header-height;
|
105
|
+
align-items: center;
|
106
|
+
|
107
|
+
@include mq(md) {
|
108
|
+
height: $header-height;
|
109
|
+
max-height: $header-height;
|
110
|
+
border-bottom: $border $border-color;
|
111
|
+
}
|
112
|
+
}
|
113
|
+
|
114
|
+
.site-title {
|
115
|
+
@include container;
|
116
|
+
|
117
|
+
flex-grow: 1;
|
118
|
+
display: flex;
|
119
|
+
height: 100%;
|
120
|
+
align-items: center;
|
121
|
+
padding-top: $sp-3;
|
122
|
+
padding-bottom: $sp-3;
|
123
|
+
color: $body-heading-color;
|
124
|
+
@include fs-6;
|
125
|
+
|
126
|
+
@include mq(md) {
|
127
|
+
padding-top: $sp-2;
|
128
|
+
padding-bottom: $sp-2;
|
129
|
+
}
|
130
|
+
}
|
131
|
+
|
132
|
+
@if variable-exists(logo) {
|
133
|
+
.site-logo {
|
134
|
+
width: 100%;
|
135
|
+
height: 100%;
|
136
|
+
background-image: url($logo);
|
137
|
+
background-repeat: no-repeat;
|
138
|
+
background-position: left center;
|
139
|
+
background-size: contain;
|
140
|
+
}
|
141
|
+
}
|
142
|
+
|
143
|
+
.site-button {
|
144
|
+
display: flex;
|
145
|
+
height: 100%;
|
146
|
+
padding: $gutter-spacing-sm;
|
147
|
+
align-items: center;
|
148
|
+
}
|
149
|
+
|
150
|
+
@include mq(md) {
|
151
|
+
.site-header .site-button {
|
152
|
+
display: none;
|
153
|
+
}
|
154
|
+
}
|
155
|
+
|
156
|
+
.site-title:hover {
|
157
|
+
background-image: linear-gradient(
|
158
|
+
-90deg,
|
159
|
+
rgba($feedback-color, 1) 0%,
|
160
|
+
rgba($feedback-color, 0.8) 80%,
|
161
|
+
rgba($feedback-color, 0) 100%
|
162
|
+
);
|
163
|
+
}
|
164
|
+
|
165
|
+
.site-button:hover {
|
166
|
+
background-image: linear-gradient(
|
167
|
+
-90deg,
|
168
|
+
rgba($feedback-color, 1) 0%,
|
169
|
+
rgba($feedback-color, 0.8) 100%
|
170
|
+
);
|
171
|
+
}
|
172
|
+
|
173
|
+
// stylelint-disable selector-max-type
|
174
|
+
|
175
|
+
body {
|
176
|
+
position: relative;
|
177
|
+
padding-bottom: $sp-10;
|
178
|
+
overflow-y: scroll;
|
179
|
+
|
180
|
+
@include mq(md) {
|
181
|
+
position: static;
|
182
|
+
padding-bottom: 0;
|
183
|
+
}
|
184
|
+
}
|
185
|
+
|
186
|
+
// stylelint-enable selector-max-type
|
187
|
+
|
188
|
+
.site-footer {
|
189
|
+
@include container;
|
190
|
+
|
191
|
+
position: absolute;
|
192
|
+
bottom: 0;
|
193
|
+
left: 0;
|
194
|
+
padding-top: $sp-4;
|
195
|
+
padding-bottom: $sp-4;
|
196
|
+
color: $grey-dk-000;
|
197
|
+
@include fs-2;
|
198
|
+
|
199
|
+
@include mq(md) {
|
200
|
+
position: static;
|
201
|
+
justify-self: end;
|
202
|
+
}
|
203
|
+
}
|
204
|
+
|
205
|
+
.icon {
|
206
|
+
width: $sp-5;
|
207
|
+
height: $sp-5;
|
208
|
+
color: $link-color;
|
209
|
+
}
|
data/_sass/modules.scss
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
// Import external dependencies
|
2
|
+
@import "./vendor/normalize.scss/normalize";
|
3
|
+
|
4
|
+
// Modules
|
5
|
+
@import "./base";
|
6
|
+
@import "./layout";
|
7
|
+
@import "./content";
|
8
|
+
@import "./navigation";
|
9
|
+
@import "./typography";
|
10
|
+
@import "./labels";
|
11
|
+
@import "./buttons";
|
12
|
+
@import "./search";
|
13
|
+
@import "./tables";
|
14
|
+
@import "./code";
|
15
|
+
@import "./utilities/utilities";
|
16
|
+
@import "./print";
|
17
|
+
@import "./skiptomain";
|