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,106 @@
1
+ /** Text **/
2
+ body{
3
+ color:rgba($black,.6);
4
+ font-size:16px;
5
+ font-family:$mainFont;
6
+ line-height:26px;
7
+ @include min-sm{
8
+ font-size:18px;
9
+ line-height:30px;
10
+ }
11
+ &.dark-mode{
12
+ color:rgba($white,.6);
13
+ background:$darkBg;
14
+ }
15
+ }
16
+ p{
17
+ margin:0 0 .5em 0;
18
+ }
19
+
20
+ /** Custom selection color **/
21
+ ::selection {
22
+ color: rgba($black,.87);
23
+ background: $yellow;
24
+ }
25
+ body.dark-mode ::selection{
26
+ color:$white;
27
+ }
28
+
29
+ /** Headings **/
30
+ h1, h2, h3, h4, h5, h6,
31
+ .h1, .h2, .h3, .h4, .h5, .h6{
32
+ margin:0 0 .5em 0;
33
+ color:$black;
34
+ font-weight:400;
35
+ font-family:$mainFont;
36
+ line-height:130%;
37
+ @include min-sm{
38
+ line-height:120%;
39
+ }
40
+ strong{
41
+ font-weight:600;
42
+ }
43
+ }
44
+ body.dark-mode h1, body.dark-mode .h1,
45
+ body.dark-mode h2, body.dark-mode .h2,
46
+ body.dark-mode h3, body.dark-mode .h3,
47
+ body.dark-mode h4, body.dark-mode .h4,
48
+ body.dark-mode h5, body.dark-mode .h5,
49
+ body.dark-mode h6, body.dark-mode .h6{
50
+ color:$white;
51
+ }
52
+ h1, .h1{
53
+ font-size:1.6875em;
54
+ @include min-sm{
55
+ font-size:2.22em;
56
+ }
57
+ }
58
+ h2, .h2{
59
+ font-size:1.5em;
60
+ @include min-sm{
61
+ font-size:1.77em;
62
+ }
63
+ }
64
+ h3, .h3{
65
+ font-size:1.3125em;
66
+ line-height:135%;
67
+ @include min-sm{
68
+ font-size:1.33em;
69
+ }
70
+ }
71
+ h4, .h4{
72
+ font-weight:600;
73
+ font-size:1em;
74
+ line-height:135%;
75
+ }
76
+
77
+ /** Code snippets **/
78
+ .code{
79
+ display:block;
80
+ margin-bottom:.75em;
81
+ font-family:$codeFont;
82
+ @include min-sm{
83
+ margin-bottom:1em;
84
+ }
85
+ &--white{
86
+ color:$white;
87
+ }
88
+ &--purple{
89
+ color:$purple;
90
+ }
91
+ &--blue{
92
+ color:$lightBlue;
93
+ }
94
+ &--green{
95
+ color:$oliveGreen;
96
+ }
97
+ &--grey{
98
+ color:#777777;
99
+ }
100
+ &--yellow{
101
+ color:#fad437;
102
+ }
103
+ &--indent{
104
+ padding-left:2em;
105
+ }
106
+ }
@@ -0,0 +1,23 @@
1
+ /** Color palette **/
2
+ $white: #ffffff;
3
+ $black: #000000;
4
+ $yellow: #FAB90F;
5
+ $blue: #334AC0;
6
+ $red: #FA420F;
7
+ $lightGrey: #F4F4F4;
8
+ $purple: #b464b4;
9
+ $oliveGreen: #a0b450;
10
+ $lightBlue: #6aacef;
11
+ $turquoise: #44C3D4;
12
+ $green: #96C84B;
13
+ $orange: #ff6400;
14
+
15
+ /** Dark mode palette **/
16
+ $darkBg: #171717;
17
+ $darkGrey: #333;
18
+ $grey: #666;
19
+
20
+ /** Font stack **/
21
+ $mainFont: "Open Sans", sans-serif;
22
+ $iconFont: "Material Icons", sans-serif;
23
+ $codeFont: "JetBrains Mono", sans-serif;
@@ -0,0 +1,35 @@
1
+ /** Import common files **/
2
+ @import 'global/normalize';
3
+ @import 'global/fonts';
4
+ @import 'global/mixins';
5
+ @import 'global/animate';
6
+ @import 'global/variables';
7
+ @import 'global/typography';
8
+ @import 'global/buttons';
9
+ @import 'global/layout';
10
+ @import 'global/slick';
11
+ @import 'global/prism';
12
+ @import 'global/alerts';
13
+
14
+ /** Import components (reusable modules) files **/
15
+ @import 'components/navbar';
16
+ @import 'components/article';
17
+ @import 'components/newsletter';
18
+ @import 'components/footer';
19
+ @import 'components/cookie-consent';
20
+
21
+ /** Import default template **/
22
+ @import 'templates/default';
23
+
24
+ /** Import docs files **/
25
+ @import 'templates/docs/layout';
26
+ @import 'templates/docs/sidebar';
27
+ @import 'templates/docs/content';
28
+ @import 'templates/docs/toc';
29
+ @import 'templates/docs/pagination';
30
+
31
+ /** Import tutorial (single post) files **/
32
+ @import 'templates/tutorials/layout';
33
+ @import 'templates/tutorials/content';
34
+ @import 'templates/tutorials/snippets';
35
+ @import 'templates/tutorials/archive';
@@ -0,0 +1,100 @@
1
+ /** Default **/
2
+ .default{
3
+ padding-top:92px;
4
+ @include min-lg{
5
+ padding-top:126px;
6
+ }
7
+ &__container{
8
+ max-width:992px;
9
+ margin:0 auto;
10
+ padding-top:12px;
11
+ padding-bottom:64px;
12
+ @include min-sm{
13
+ padding-top:24px;
14
+ padding-bottom:96px;
15
+ }
16
+ @include min-lg{
17
+ padding-top:36px;
18
+ padding-bottom:120px;
19
+ }
20
+ }
21
+ &__title{
22
+ margin-bottom:.75em;
23
+ font-weight:600;
24
+ }
25
+ &__content{
26
+ h2{
27
+ margin:2em 0 .5em 0;
28
+ color:rgba($black,.6);
29
+ font-weight:600;
30
+ font-size:1.3125em;
31
+ line-height:135%;
32
+ @include min-sm{
33
+ font-size:1.33em;
34
+ }
35
+ &:first-of-type{
36
+ margin-top:1em;
37
+ }
38
+ }
39
+ h3{
40
+ margin:1.5em 0 .5em 0;
41
+ font-weight:600;
42
+ @include min-sm{
43
+ font-size:1.166em;
44
+ }
45
+ }
46
+ h4{
47
+ margin:1.25em 0 .25em 0;
48
+ }
49
+ p{
50
+ margin:0 0 1em 0;
51
+ }
52
+ p, li, pre, code{
53
+ @include min-sm{
54
+ font-size:16px;
55
+ line-height:28px;
56
+ }
57
+ }
58
+ ul{
59
+ margin:24px 0;
60
+ padding:0 0 0 36px;
61
+ list-style-type:none;
62
+ li{
63
+ margin:0 0 .5em 0;
64
+ }
65
+ li::before{
66
+ @include material-icons;
67
+ margin:0 6px 0 -30px;
68
+ color:rgba($black,.38);
69
+ font-size:24px;
70
+ vertical-align:middle;
71
+ content:"chevron_right";
72
+ }
73
+ li ul{
74
+ margin:.5em 0 1em 0;
75
+ }
76
+ }
77
+ a{
78
+ color:$blue;
79
+ font-weight:600;
80
+ text-decoration:none;
81
+ &:hover{
82
+ text-decoration: underline;
83
+ }
84
+ }
85
+ }
86
+ }
87
+
88
+ /** Dark mode styles **/
89
+ body.dark-mode .default{
90
+ &__content{
91
+ a{
92
+ color:$yellow;
93
+ }
94
+ ul {
95
+ li::before{
96
+ color:rgba($white,.38);
97
+ }
98
+ }
99
+ }
100
+ }
@@ -0,0 +1,113 @@
1
+ /** Docs -- Content **/
2
+ .docs{
3
+ &__content{
4
+ width:100%;
5
+ @include min-sm{
6
+ max-width:calc(100% - 288px);
7
+ margin:0 0 0 48px;
8
+ }
9
+ @include min-lg{
10
+ max-width:calc(100% - 348px);
11
+ }
12
+ @include min-xxl{
13
+ max-width:680px;
14
+ margin:0 64px 0 72px;
15
+ }
16
+ h1{
17
+ margin:.25em 0 .5em 0;
18
+ color:$black;
19
+ font-weight:600;
20
+ font-size:1.5em;
21
+ @include min-sm{
22
+ font-size:1.77em;
23
+ }
24
+ }
25
+ h2{
26
+ margin:2em 0 .5em 0;
27
+ color:rgba($black,.6);
28
+ font-weight:600;
29
+ font-size:1.3125em;
30
+ line-height:135%;
31
+ @include min-sm{
32
+ font-size:1.33em;
33
+ }
34
+ &:first-of-type{
35
+ margin-top:1em;
36
+ }
37
+ }
38
+ h3{
39
+ margin:2em 0 .5em 0;
40
+ font-weight:600;
41
+ @include min-sm{
42
+ font-size:1.166em;
43
+ }
44
+ }
45
+ p, li{
46
+ @include min-sm{
47
+ font-size:16px;
48
+ line-height:28px;
49
+ }
50
+ a:not(.docs__pagination-item){
51
+ color:$blue;
52
+ font-weight:600;
53
+ text-decoration:none;
54
+ &:hover{
55
+ text-decoration: underline;
56
+ }
57
+ }
58
+ }
59
+ pre, code{
60
+ @include min-sm{
61
+ font-size:16px;
62
+ line-height:28px;
63
+ }
64
+ }
65
+ p:not(.alert__content){
66
+ margin:0 0 1em 0;
67
+ }
68
+ ul{
69
+ margin:24px 0;
70
+ padding:0 0 0 36px;
71
+ list-style-type:none;
72
+ li{
73
+ margin:.1em 0;
74
+ }
75
+ li::before{
76
+ @include material-icons;
77
+ margin:0 6px 0 -30px;
78
+ color:rgba($black,.38);
79
+ font-size:24px;
80
+ vertical-align:middle;
81
+ content:"chevron_right";
82
+ }
83
+ }
84
+ pre{
85
+ margin:24px 0;
86
+ }
87
+ img{
88
+ max-width:100%;
89
+ height:auto;
90
+ margin:1em 0 0 0;
91
+ border-radius:8px;
92
+ }
93
+ code{
94
+ font-family:$codeFont;
95
+ }
96
+ }
97
+ }
98
+
99
+ /** Dark mode styles **/
100
+ body.dark-mode .docs{
101
+ &__content{
102
+ p, li, pre, code{
103
+ a:not(.docs__pagination-item){
104
+ color:$yellow;
105
+ }
106
+ }
107
+ ul{
108
+ li::before{
109
+ color:rgba($white,.38);
110
+ }
111
+ }
112
+ }
113
+ }
@@ -0,0 +1,21 @@
1
+ /** Docs -- Layout **/
2
+ .docs{
3
+ &__container{
4
+ padding-top:12px;
5
+ padding-bottom:64px;
6
+ @include min-sm{
7
+ padding-top:24px;
8
+ padding-bottom:96px;
9
+ }
10
+ @include min-lg{
11
+ padding-bottom:150px;
12
+ }
13
+ }
14
+ &__row{
15
+ position:relative;
16
+ align-items:flex-start;
17
+ @include min-sm{
18
+ flex-wrap:nowrap;
19
+ }
20
+ }
21
+ }
@@ -0,0 +1,48 @@
1
+ /** Docs -- Prev/next nav **/
2
+ .docs{
3
+ &__pagination{
4
+ display:flex;
5
+ flex-direction:row;
6
+ flex-wrap:wrap;
7
+ align-items:center;
8
+ justify-content:space-between;
9
+ margin-top:36px;
10
+ padding-top:18px;
11
+ border-top:1px solid rgba($black,.12);
12
+ @include min-lg{
13
+ flex-wrap:nowrap;
14
+ }
15
+ &-item{
16
+ color:$yellow;
17
+ font-weight:600;
18
+ font-family:$mainFont;
19
+ text-decoration:none;
20
+ &::before,
21
+ &::after{
22
+ @include material-icons;
23
+ display:inline-block;
24
+ font-size:24px;
25
+ vertical-align:-6px;
26
+ }
27
+ &--prev{
28
+ margin-right:auto;
29
+ }
30
+ &--prev::before{
31
+ content:"arrow_left";
32
+ }
33
+ &--next{
34
+ margin-left:auto;
35
+ }
36
+ &--next::after{
37
+ content:"arrow_right";
38
+ }
39
+ }
40
+ }
41
+ }
42
+
43
+ /** Dark mode styles **/
44
+ body.dark-mode .docs{
45
+ &__pagination{
46
+ border-color:rgba($white,.12);
47
+ }
48
+ }