bytewax-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.
Files changed (136) hide show
  1. checksums.yaml +7 -0
  2. data/.stylelintrc +13 -0
  3. data/LICENSE.txt +21 -0
  4. data/README.md +175 -0
  5. data/_assets/js/cookies.js +39 -0
  6. data/_assets/js/docs.js +103 -0
  7. data/_assets/js/lib/jquery-3.6.0.min.js +2 -0
  8. data/_assets/js/lib/jquery.scrollspy.js +97 -0
  9. data/_assets/js/lib/marked.min.js +6 -0
  10. data/_assets/js/lib/notebook.min.js +1 -0
  11. data/_assets/js/lib/prism.js +17 -0
  12. data/_assets/js/lib/simple-jekyll-search.min.js +6 -0
  13. data/_assets/js/navbar.js +90 -0
  14. data/_assets/js/search.js +12 -0
  15. data/_assets/js/tutorial.js +248 -0
  16. data/_assets/scss/components/article.scss +132 -0
  17. data/_assets/scss/components/cookie-consent.scss +35 -0
  18. data/_assets/scss/components/footer.scss +154 -0
  19. data/_assets/scss/components/navbar.scss +345 -0
  20. data/_assets/scss/components/newsletter.scss +222 -0
  21. data/_assets/scss/global/alerts.scss +112 -0
  22. data/_assets/scss/global/animate.scss +633 -0
  23. data/_assets/scss/global/buttons.scss +186 -0
  24. data/_assets/scss/global/fonts.scss +95 -0
  25. data/_assets/scss/global/layout.scss +25 -0
  26. data/_assets/scss/global/mixins.scss +134 -0
  27. data/_assets/scss/global/normalize.scss +349 -0
  28. data/_assets/scss/global/prism.scss +383 -0
  29. data/_assets/scss/global/slick.scss +133 -0
  30. data/_assets/scss/global/typography.scss +106 -0
  31. data/_assets/scss/global/variables.scss +23 -0
  32. data/_assets/scss/main.scss +35 -0
  33. data/_assets/scss/templates/default.scss +100 -0
  34. data/_assets/scss/templates/docs/content.scss +113 -0
  35. data/_assets/scss/templates/docs/layout.scss +21 -0
  36. data/_assets/scss/templates/docs/pagination.scss +48 -0
  37. data/_assets/scss/templates/docs/sidebar.scss +222 -0
  38. data/_assets/scss/templates/docs/toc.scss +65 -0
  39. data/_assets/scss/templates/tutorials/archive.scss +173 -0
  40. data/_assets/scss/templates/tutorials/content.scss +208 -0
  41. data/_assets/scss/templates/tutorials/layout.scss +22 -0
  42. data/_assets/scss/templates/tutorials/snippets.scss +259 -0
  43. data/_config.yml +84 -0
  44. data/_data/categories.yml +3 -0
  45. data/_data/cookies.yml +10 -0
  46. data/_data/footer.yml +14 -0
  47. data/_data/navbar.yml +17 -0
  48. data/_docs/another-article.md +19 -0
  49. data/_docs/sample-article.md +19 -0
  50. data/_includes/alert.html +4 -0
  51. data/_includes/cookie-consent.html +13 -0
  52. data/_includes/docs/pagination.html +28 -0
  53. data/_includes/docs/sidebar.html +42 -0
  54. data/_includes/docs/toc.html +4 -0
  55. data/_includes/footer.html +36 -0
  56. data/_includes/google_analytics.html +12 -0
  57. data/_includes/head.html +73 -0
  58. data/_includes/navbar.html +57 -0
  59. data/_includes/tutorials/content.html +30 -0
  60. data/_includes/tutorials/post.html +31 -0
  61. data/_includes/tutorials/snippets.html +36 -0
  62. data/_layouts/base.html +21 -0
  63. data/_layouts/default.html +14 -0
  64. data/_layouts/docs.html +32 -0
  65. data/_layouts/tutorial.html +17 -0
  66. data/_layouts/tutorials.html +26 -0
  67. data/_tutorials/hello-world.md +142 -0
  68. data/assets/css/docs.css +1 -0
  69. data/assets/css/main.css +8 -0
  70. data/assets/fonts/jetbrains-mono-v3-latin-regular.eot +0 -0
  71. data/assets/fonts/jetbrains-mono-v3-latin-regular.svg +318 -0
  72. data/assets/fonts/jetbrains-mono-v3-latin-regular.ttf +0 -0
  73. data/assets/fonts/jetbrains-mono-v3-latin-regular.woff +0 -0
  74. data/assets/fonts/jetbrains-mono-v3-latin-regular.woff2 +0 -0
  75. data/assets/fonts/material-icons.woff2 +0 -0
  76. data/assets/fonts/open-sans-v18-latin-600.eot +0 -0
  77. data/assets/fonts/open-sans-v18-latin-600.svg +336 -0
  78. data/assets/fonts/open-sans-v18-latin-600.ttf +0 -0
  79. data/assets/fonts/open-sans-v18-latin-600.woff +0 -0
  80. data/assets/fonts/open-sans-v18-latin-600.woff2 +0 -0
  81. data/assets/fonts/open-sans-v18-latin-600italic.eot +0 -0
  82. data/assets/fonts/open-sans-v18-latin-600italic.svg +349 -0
  83. data/assets/fonts/open-sans-v18-latin-600italic.ttf +0 -0
  84. data/assets/fonts/open-sans-v18-latin-600italic.woff +0 -0
  85. data/assets/fonts/open-sans-v18-latin-600italic.woff2 +0 -0
  86. data/assets/fonts/open-sans-v18-latin-700.eot +0 -0
  87. data/assets/fonts/open-sans-v18-latin-700.svg +334 -0
  88. data/assets/fonts/open-sans-v18-latin-700.ttf +0 -0
  89. data/assets/fonts/open-sans-v18-latin-700.woff +0 -0
  90. data/assets/fonts/open-sans-v18-latin-700.woff2 +0 -0
  91. data/assets/fonts/open-sans-v18-latin-700italic.eot +0 -0
  92. data/assets/fonts/open-sans-v18-latin-700italic.svg +342 -0
  93. data/assets/fonts/open-sans-v18-latin-700italic.ttf +0 -0
  94. data/assets/fonts/open-sans-v18-latin-700italic.woff +0 -0
  95. data/assets/fonts/open-sans-v18-latin-700italic.woff2 +0 -0
  96. data/assets/fonts/open-sans-v18-latin-italic.eot +0 -0
  97. data/assets/fonts/open-sans-v18-latin-italic.svg +349 -0
  98. data/assets/fonts/open-sans-v18-latin-italic.ttf +0 -0
  99. data/assets/fonts/open-sans-v18-latin-italic.woff +0 -0
  100. data/assets/fonts/open-sans-v18-latin-italic.woff2 +0 -0
  101. data/assets/fonts/open-sans-v18-latin-regular.eot +0 -0
  102. data/assets/fonts/open-sans-v18-latin-regular.svg +336 -0
  103. data/assets/fonts/open-sans-v18-latin-regular.ttf +0 -0
  104. data/assets/fonts/open-sans-v18-latin-regular.woff +0 -0
  105. data/assets/fonts/open-sans-v18-latin-regular.woff2 +0 -0
  106. data/assets/img/cancel-grey.svg +11 -0
  107. data/assets/img/cancel.svg +3 -0
  108. data/assets/img/facebook-yellow.svg +11 -0
  109. data/assets/img/facebook.svg +3 -0
  110. data/assets/img/favicon.png +0 -0
  111. data/assets/img/github_black.svg +4 -0
  112. data/assets/img/github_white.svg +4 -0
  113. data/assets/img/linkedin-yellow.svg +12 -0
  114. data/assets/img/linkedin.svg +3 -0
  115. data/assets/img/logo.svg +44 -0
  116. data/assets/img/logo_mono.svg +40 -0
  117. data/assets/img/logo_white.svg +46 -0
  118. data/assets/img/logo_yellow.svg +44 -0
  119. data/assets/img/og-image.png +0 -0
  120. data/assets/img/twitter-yellow.svg +14 -0
  121. data/assets/img/twitter.svg +3 -0
  122. data/assets/js/color-mode.min.js +2 -0
  123. data/assets/js/scripts.js +625 -0
  124. data/assets/js/scripts.min.js +56 -0
  125. data/gulpfile.js +49 -0
  126. data/package-lock.json +7350 -0
  127. data/package.json +34 -0
  128. data/search.json +13 -0
  129. data/tutorials/hello-world/Dockerfile +4 -0
  130. data/tutorials/hello-world/client.py +3 -0
  131. data/tutorials/hello-world/hello-world.png +0 -0
  132. data/tutorials/hello-world/hello.py +10 -0
  133. data/tutorials/hello-world/setup.sh +5 -0
  134. data/tutorials/hello-world/shell_commands.sh +5 -0
  135. data/tutorials/hello-world/swarm.yaml +26 -0
  136. metadata +191 -0
@@ -0,0 +1,208 @@
1
+ /** Tutorial -- Content **/
2
+ .tutorial{
3
+ &__content{
4
+ width:100%;
5
+ @include min-lg{
6
+ width:calc(50% - 24px);
7
+ margin:0 auto 0 0;
8
+ }
9
+ @include min-xxl{
10
+ width:calc(40% - 24px);
11
+ }
12
+ }
13
+ &__intro{
14
+ margin-bottom:36px;
15
+ padding-bottom:27px;
16
+ border-bottom:1px solid rgba($black,.12);
17
+ @include min-sm{
18
+ margin-bottom:48px;
19
+ padding-bottom:36px;
20
+ }
21
+ &-link{
22
+ display:inline-block;
23
+ color:$yellow;
24
+ font-weight:600;
25
+ font-size:.888em;
26
+ font-family:$mainFont;
27
+ line-height:150%;
28
+ text-decoration:none;
29
+ &::before{
30
+ margin-left:-7px;
31
+ font-size:24px;
32
+ line-height:1;
33
+ vertical-align:-7px;
34
+ content:"arrow_left";
35
+ @include material-icons;
36
+ }
37
+ }
38
+ }
39
+ &__title{
40
+ margin:.25em 0 .375em 0;
41
+ color:$black;
42
+ font-weight:600;
43
+ font-size:1.5em;
44
+ @include min-sm{
45
+ font-size:1.77em;
46
+ }
47
+ }
48
+ &__description{
49
+ margin:0;
50
+ }
51
+ &__buttons{
52
+ display:flex;
53
+ flex-direction:row;
54
+ flex-wrap:wrap;
55
+ margin-top:27px;
56
+ @include min-xxl{
57
+ margin-top:36px;
58
+ }
59
+ .btn{
60
+ margin-right:12px;
61
+ margin-bottom:8px;
62
+ @include min-xxl{
63
+ margin-bottom:0;
64
+ }
65
+ }
66
+ }
67
+
68
+ /** Case study -- Entry content **/
69
+ &__text{
70
+ h1{
71
+ margin:0 0 .25em 0;
72
+ color:$black;
73
+ font-weight:600;
74
+ font-size:1.5em;
75
+ @include min-sm{
76
+ font-size:1.77em;
77
+ }
78
+ }
79
+ h2{
80
+ margin:1.5em 0 .25em 0;
81
+ padding:0 36px;
82
+ font-weight:600;
83
+ font-size:1.3125em;
84
+ line-height:135%;
85
+ @include min-sm{
86
+ margin:2em 0 .25em 0;
87
+ font-size:1.33em;
88
+ }
89
+ &:first-of-type{
90
+ margin-top:1em;
91
+ }
92
+ &::before{
93
+ display:inline-block;
94
+ width:24px;
95
+ height:24px;
96
+ margin:0 12px 0 -36px;
97
+ padding:4px 0;
98
+ color:$white;
99
+ font-weight:700;
100
+ font-size:16px;
101
+ line-height:1;
102
+ text-align:center;
103
+ vertical-align:3px;
104
+ background:$yellow;
105
+ border-radius:50%;
106
+ content:attr(data-count);
107
+ }
108
+ }
109
+ h3, h4{
110
+ margin:1.5em 0 1em 0;
111
+ font-weight:600;
112
+ font-size:1em;
113
+ @include min-sm{
114
+ font-size:1.166em;
115
+ }
116
+ }
117
+ p{
118
+ margin:0;
119
+ padding:21px 36px 27px 33px;
120
+ font-size:14px;
121
+ line-height:24px;
122
+ border-bottom:1px solid rgba($black,.12);
123
+ border-left:3px solid transparent;
124
+ cursor:pointer;
125
+ @include transition(.25s ease-in-out);
126
+ @include min-sm{
127
+ font-size:16px;
128
+ line-height:28px;
129
+ }
130
+ &:last-of-type{
131
+ border-bottom:0;
132
+ }
133
+ &:hover{
134
+ border-left-color:$lightGrey;
135
+ }
136
+ &.highlight{
137
+ border-left-color:$yellow;
138
+ }
139
+ &.highlight strong{
140
+ color:rgba($black,.87);
141
+ }
142
+ }
143
+ a{
144
+ color:$blue;
145
+ font-weight:600;
146
+ text-decoration:none;
147
+ &:hover{
148
+ text-decoration:underline;
149
+ }
150
+ }
151
+ img{
152
+ max-width:100%;
153
+ height:auto;
154
+ margin-top:1em;
155
+ }
156
+ strong{
157
+ display:block;
158
+ margin-bottom:.25em;
159
+ }
160
+ ul{
161
+ margin:24px 0;
162
+ padding:0 0 0 30px;
163
+ list-style-type:none;
164
+ li{
165
+ margin:0 0 8px 0;
166
+ font-size:14px;
167
+ line-height:24px;
168
+ @include min-sm{
169
+ margin:0 0 12px 0;
170
+ font-size:16px;
171
+ line-height:28px;
172
+ }
173
+ }
174
+ li::before{
175
+ @include material-icons;
176
+ margin:0 6px 0 -30px;
177
+ color:rgba($black,.38);
178
+ font-size:24px;
179
+ vertical-align:-7px;
180
+ content:"chevron_right";
181
+ }
182
+ }
183
+ }
184
+ }
185
+
186
+ /** Dark mode styles **/
187
+ body.dark-mode .tutorial{
188
+ &__intro{
189
+ border-color:rgba($white,.12);
190
+ }
191
+ &__text{
192
+ p{
193
+ border-bottom:1px solid rgba($white,.12);
194
+ &:hover{
195
+ border-left-color:rgba($white,.38);
196
+ }
197
+ &.highlight strong{
198
+ color:rgba($white,.87);
199
+ }
200
+ }
201
+ a{
202
+ color:$yellow;
203
+ }
204
+ li::before{
205
+ color:rgba($white,.38);
206
+ }
207
+ }
208
+ }
@@ -0,0 +1,22 @@
1
+ /** Tutorial -- Layout **/
2
+ .tutorial{
3
+ &__container{
4
+ position:relative;
5
+ padding-top:12px;
6
+ padding-bottom:72px;
7
+ @include min-sm{
8
+ padding-top:24px;
9
+ padding-bottom:96px;
10
+ }
11
+ @include min-lg{
12
+ padding-bottom:150px;
13
+ }
14
+ }
15
+ &__row{
16
+ position:relative;
17
+ align-items:flex-start;
18
+ @include min-lg{
19
+ flex-wrap:nowrap;
20
+ }
21
+ }
22
+ }
@@ -0,0 +1,259 @@
1
+ /** Tutorial -- Code snippet **/
2
+ .tutorial{
3
+ &__snippets{
4
+ width:100%;
5
+ padding-top:24px;
6
+ font-size:14px;
7
+ line-height:22px;
8
+ @include min-sm{
9
+ padding-top:36px;
10
+ font-size:16px;
11
+ line-height:28px;
12
+ }
13
+ @include min-lg{
14
+ position:sticky;
15
+ top:126px;
16
+ left:0;
17
+ width:calc(50% - 24px);
18
+ margin:0 0 0 auto;
19
+ padding-top:0;
20
+ }
21
+ @include min-xxl{
22
+ width:calc(60% - 24px);
23
+ }
24
+ &-nav{
25
+ display:flex;
26
+ flex-direction:row;
27
+ flex-wrap:wrap;
28
+ margin:0;
29
+ padding:0;
30
+ list-style-type:none;
31
+ @include min-sm{
32
+ flex-wrap:nowrap;
33
+ overflow-x:auto;
34
+ overflow-y:hidden;
35
+ }
36
+ &-item{
37
+ width:100%;
38
+ border-left:3px solid transparent;
39
+ @include transition(.25s ease-in-out);
40
+ @include min-sm{
41
+ width:auto;
42
+ border-bottom:3px solid transparent;
43
+ border-left:0;
44
+ }
45
+ &--active{
46
+ border-color:$yellow;
47
+ }
48
+ }
49
+ &-link{
50
+ display:block;
51
+ padding:10px 12px;
52
+ color:rgba($black,.6);
53
+ font-weight:600;
54
+ font-size:14px;
55
+ line-height:22px;
56
+ text-decoration:none;
57
+ @include transition(.25s ease-in-out);
58
+ @include min-sm{
59
+ padding:3px 16px 12px 16px;
60
+ white-space:nowrap;
61
+ }
62
+ &::before{
63
+ display:inline-block;
64
+ margin-right:8px;
65
+ color:rgba($black,.18);
66
+ font-size:24px;
67
+ line-height:1;
68
+ vertical-align:-7px;
69
+ content:"code";
70
+ @include material-icons;
71
+ }
72
+ &--notebook::before{
73
+ content:"summarize";
74
+ }
75
+ }
76
+ &-item--active &-link{
77
+ color:rgba($black,.87);
78
+ &::before{
79
+ color:rgba($black,.38);
80
+ }
81
+ }
82
+ }
83
+ &-tabs{
84
+ div.code-toolbar>.toolbar{
85
+ display:none;
86
+ }
87
+ div.code-toolbar:hover>.toolbar{
88
+ display:block;
89
+ }
90
+ }
91
+ &-tab{
92
+ display:none;
93
+ margin:0!important;
94
+ overflow:auto;
95
+ outline:none;
96
+ @include transition(background-color .5s ease-in-out);
97
+ @include min-lg{
98
+ max-height:calc(100vh - 168px - 72px);
99
+ }
100
+ &--active{
101
+ display:block;
102
+ }
103
+ &--highlight{
104
+ background-color: #dedede!important;
105
+ }
106
+ }
107
+ &-buttons{
108
+ display: flex;
109
+ flex-direction: row;
110
+ align-items: center;
111
+ justify-content: space-between;
112
+ margin:24px 0;
113
+ }
114
+ &-btn{
115
+ padding:0;
116
+ color:$yellow;
117
+ font-weight:600;
118
+ font-size:14px;
119
+ background:transparent;
120
+ border:0;
121
+ border-radius:0;
122
+ cursor:pointer;
123
+ &--prev::before,
124
+ &--next::after{
125
+ @include material-icons;
126
+ display:inline-block;
127
+ font-size:24px;
128
+ line-height:24px;
129
+ vertical-align: -7px;
130
+ }
131
+ &--prev::before{
132
+ content:"arrow_left";
133
+ }
134
+ &--next::after{
135
+ content:"arrow_right";
136
+ }
137
+ &--inactive{
138
+ color:rgba($black,.38);
139
+ cursor: not-allowed;
140
+ }
141
+ }
142
+ }
143
+ }
144
+
145
+ /** Dark mode styles **/
146
+ body.dark-mode .tutorial{
147
+ &__snippets{
148
+ &-nav{
149
+ border-bottom-color:rgba($white,.12);
150
+ &-link{
151
+ color:rgba($white,.6);
152
+ &::before{
153
+ color:rgba($white,.18);
154
+ }
155
+ }
156
+ &-item--active .tutorial__snippets-nav-link{
157
+ color:rgba($white,.87);
158
+ &::before{
159
+ color:rgba($white,.38);
160
+ }
161
+ }
162
+ }
163
+ &-tab--highlight{
164
+ background-color: #444!important;
165
+ }
166
+ &-btn--inactive{
167
+ color:rgba($white,.38);
168
+ }
169
+ }
170
+ }
171
+
172
+ /** Notebook render styling **/
173
+ .nb{
174
+ &-markdown-cell{
175
+ padding-top:12px;
176
+ padding-bottom:1.5em;
177
+ h1, h2, h3, h4, h5{
178
+ font-weight:600;
179
+ font-family:$mainFont;
180
+ }
181
+ h1{
182
+ font-size:1.5em;
183
+ @include min-sm{
184
+ font-size:1.77em;
185
+ }
186
+ }
187
+ h2{
188
+ font-size:1.3125em;
189
+ @include min-sm{
190
+ font-size:1.33em;
191
+ }
192
+ }
193
+ h3, h4,h5{
194
+ font-size:1em;
195
+ }
196
+ }
197
+ &-stdout,
198
+ &-stderr {
199
+ margin: 1em 0;
200
+ white-space: pre-wrap;
201
+ }
202
+ &-cell {
203
+ position: relative;
204
+ padding-left:96px;
205
+ border-bottom:1px solid rgba($black,.12);
206
+ &:last-of-type{
207
+ border-bottom:0;
208
+ }
209
+ &--highlight{
210
+ background: rgba($black,.09);
211
+ background: linear-gradient(to right, rgba($black,.09) 70%, rgba($black,0));
212
+ }
213
+ pre[class*=language-]{
214
+ background:transparent;
215
+ }
216
+ }
217
+ &-cell + .nb-cell {
218
+ margin-top: 0.5em;
219
+ }
220
+ &-input,
221
+ &-output{
222
+ position: relative;
223
+ }
224
+ &-output:before,
225
+ &-input:before {
226
+ position: absolute;
227
+ top: .75em;
228
+ left: -96px;
229
+ width: 96px;
230
+ padding-right:6px;
231
+ color: rgba($black,.38);
232
+ font-family: $codeFont;
233
+ text-align: right;
234
+ }
235
+ &-input:before {
236
+ content: "In [" attr(data-prompt-number) "]:";
237
+ }
238
+ &-output:before {
239
+ content: "Out [" attr(data-prompt-number) "]:";
240
+ }
241
+ }
242
+
243
+ /** Dark mode **/
244
+ body.dark-mode .nb{
245
+ &-output:before,
246
+ &-input:before {
247
+ color:rgba($white,.38);
248
+ }
249
+ &-cell{
250
+ border-bottom:1px solid rgba($white,.12);
251
+ pre[class*=language-]{
252
+ background:transparent;
253
+ }
254
+ }
255
+ &-cell--highlight{
256
+ background: rgba($white,.09);
257
+ background: linear-gradient(to right, rgba($white,.09) 70%, rgba($white,0));
258
+ }
259
+ }