coffeebrew_jekyll_docs 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (43) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +5 -0
  3. data/LICENSE +21 -0
  4. data/README.md +77 -0
  5. data/_includes/navigation.html +11 -0
  6. data/_layouts/default.html +53 -0
  7. data/_layouts/version.html +4 -0
  8. data/_sass/fontawesome/scss/_animated.scss +153 -0
  9. data/_sass/fontawesome/scss/_bordered-pulled.scss +20 -0
  10. data/_sass/fontawesome/scss/_core.scss +43 -0
  11. data/_sass/fontawesome/scss/_fixed-width.scss +7 -0
  12. data/_sass/fontawesome/scss/_functions.scss +57 -0
  13. data/_sass/fontawesome/scss/_icons.scss +10 -0
  14. data/_sass/fontawesome/scss/_list.scss +18 -0
  15. data/_sass/fontawesome/scss/_mixins.scss +75 -0
  16. data/_sass/fontawesome/scss/_rotated-flipped.scss +31 -0
  17. data/_sass/fontawesome/scss/_screen-reader.scss +14 -0
  18. data/_sass/fontawesome/scss/_shims.scss +2042 -0
  19. data/_sass/fontawesome/scss/_sizing.scss +16 -0
  20. data/_sass/fontawesome/scss/_stacked.scss +32 -0
  21. data/_sass/fontawesome/scss/_variables.scss +4961 -0
  22. data/_sass/fontawesome/scss/brands.scss +30 -0
  23. data/_sass/fontawesome/scss/fontawesome.scss +21 -0
  24. data/_sass/fontawesome/scss/regular.scss +26 -0
  25. data/_sass/fontawesome/scss/solid.scss +26 -0
  26. data/_sass/fontawesome/scss/v4-shims.scss +11 -0
  27. data/_sass/fonts.scss +107 -0
  28. data/_sass/main.scss +309 -0
  29. data/assets/css/styles.scss +8 -0
  30. data/assets/js/main.js +14 -0
  31. data/assets/webfonts/Quicksand-Bold.ttf +0 -0
  32. data/assets/webfonts/Quicksand-Bold.woff2 +0 -0
  33. data/assets/webfonts/Quicksand-Medium.ttf +0 -0
  34. data/assets/webfonts/Quicksand-Medium.woff2 +0 -0
  35. data/assets/webfonts/fa-brands-400.ttf +0 -0
  36. data/assets/webfonts/fa-brands-400.woff2 +0 -0
  37. data/assets/webfonts/fa-regular-400.ttf +0 -0
  38. data/assets/webfonts/fa-regular-400.woff2 +0 -0
  39. data/assets/webfonts/fa-solid-900.ttf +0 -0
  40. data/assets/webfonts/fa-solid-900.woff2 +0 -0
  41. data/assets/webfonts/fa-v4compatibility.ttf +0 -0
  42. data/assets/webfonts/fa-v4compatibility.woff2 +0 -0
  43. metadata +151 -0
@@ -0,0 +1,30 @@
1
+ /*!
2
+ * Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com
3
+ * License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
4
+ * Copyright 2023 Fonticons, Inc.
5
+ */
6
+ @import 'functions';
7
+ @import 'variables';
8
+
9
+ :root, :host {
10
+ --#{$fa-css-prefix}-style-family-brands: 'Font Awesome 6 Brands';
11
+ --#{$fa-css-prefix}-font-brands: normal 400 1em/1 'Font Awesome 6 Brands';
12
+ }
13
+
14
+ @font-face {
15
+ font-family: 'Font Awesome 6 Brands';
16
+ font-style: normal;
17
+ font-weight: 400;
18
+ font-display: $fa-font-display;
19
+ src: url('#{$fa-font-path}/fa-brands-400.woff2') format('woff2'),
20
+ url('#{$fa-font-path}/fa-brands-400.ttf') format('truetype');
21
+ }
22
+
23
+ .fab,
24
+ .#{$fa-css-prefix}-brands {
25
+ font-weight: 400;
26
+ }
27
+
28
+ @each $name, $icon in $fa-brand-icons {
29
+ .#{$fa-css-prefix}-#{$name}:before { content: unquote("\"#{ $icon }\""); }
30
+ }
@@ -0,0 +1,21 @@
1
+ /*!
2
+ * Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com
3
+ * License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
4
+ * Copyright 2023 Fonticons, Inc.
5
+ */
6
+ // Font Awesome core compile (Web Fonts-based)
7
+ // -------------------------
8
+
9
+ @import 'functions';
10
+ @import 'variables';
11
+ @import 'mixins';
12
+ @import 'core';
13
+ @import 'sizing';
14
+ @import 'fixed-width';
15
+ @import 'list';
16
+ @import 'bordered-pulled';
17
+ @import 'animated';
18
+ @import 'rotated-flipped';
19
+ @import 'stacked';
20
+ @import 'icons';
21
+ @import 'screen-reader';
@@ -0,0 +1,26 @@
1
+ /*!
2
+ * Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com
3
+ * License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
4
+ * Copyright 2023 Fonticons, Inc.
5
+ */
6
+ @import 'functions';
7
+ @import 'variables';
8
+
9
+ :root, :host {
10
+ --#{$fa-css-prefix}-style-family-classic: '#{ $fa-style-family }';
11
+ --#{$fa-css-prefix}-font-regular: normal 400 1em/1 '#{ $fa-style-family }';
12
+ }
13
+
14
+ @font-face {
15
+ font-family: 'Font Awesome 6 Free';
16
+ font-style: normal;
17
+ font-weight: 400;
18
+ font-display: $fa-font-display;
19
+ src: url('#{$fa-font-path}/fa-regular-400.woff2') format('woff2'),
20
+ url('#{$fa-font-path}/fa-regular-400.ttf') format('truetype');
21
+ }
22
+
23
+ .far,
24
+ .#{$fa-css-prefix}-regular {
25
+ font-weight: 400;
26
+ }
@@ -0,0 +1,26 @@
1
+ /*!
2
+ * Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com
3
+ * License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
4
+ * Copyright 2023 Fonticons, Inc.
5
+ */
6
+ @import 'functions';
7
+ @import 'variables';
8
+
9
+ :root, :host {
10
+ --#{$fa-css-prefix}-style-family-classic: '#{ $fa-style-family }';
11
+ --#{$fa-css-prefix}-font-solid: normal 900 1em/1 '#{ $fa-style-family }';
12
+ }
13
+
14
+ @font-face {
15
+ font-family: 'Font Awesome 6 Free';
16
+ font-style: normal;
17
+ font-weight: 900;
18
+ font-display: $fa-font-display;
19
+ src: url('#{$fa-font-path}/fa-solid-900.woff2') format('woff2'),
20
+ url('#{$fa-font-path}/fa-solid-900.ttf') format('truetype');
21
+ }
22
+
23
+ .fas,
24
+ .#{$fa-css-prefix}-solid {
25
+ font-weight: 900;
26
+ }
@@ -0,0 +1,11 @@
1
+ /*!
2
+ * Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com
3
+ * License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
4
+ * Copyright 2023 Fonticons, Inc.
5
+ */
6
+ // V4 shims compile (Web Fonts-based)
7
+ // -------------------------
8
+
9
+ @import 'functions';
10
+ @import 'variables';
11
+ @import 'shims';
data/_sass/fonts.scss ADDED
@@ -0,0 +1,107 @@
1
+ // Copyright 2011 The Quicksand Project Authors (https://github.com/andrew-paglinawan/QuicksandFamily), with Reserved Font Name “Quicksand”.
2
+ //
3
+ // This Font Software is licensed under the SIL Open Font License, Version 1.1.
4
+ // This license is copied below, and is also available with a FAQ at:
5
+ // http://scripts.sil.org/OFL
6
+ //
7
+ //
8
+ // -----------------------------------------------------------
9
+ // SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10
+ // -----------------------------------------------------------
11
+ //
12
+ // PREAMBLE
13
+ // The goals of the Open Font License (OFL) are to stimulate worldwide
14
+ // development of collaborative font projects, to support the font creation
15
+ // efforts of academic and linguistic communities, and to provide a free and
16
+ // open framework in which fonts may be shared and improved in partnership
17
+ // with others.
18
+ //
19
+ // The OFL allows the licensed fonts to be used, studied, modified and
20
+ // redistributed freely as long as they are not sold by themselves. The
21
+ // fonts, including any derivative works, can be bundled, embedded,
22
+ // redistributed and/or sold with any software provided that any reserved
23
+ // names are not used by derivative works. The fonts and derivatives,
24
+ // however, cannot be released under any other type of license. The
25
+ // requirement for fonts to remain under this license does not apply
26
+ // to any document created using the fonts or their derivatives.
27
+ //
28
+ // DEFINITIONS
29
+ // "Font Software" refers to the set of files released by the Copyright
30
+ // Holder(s) under this license and clearly marked as such. This may
31
+ // include source files, build scripts and documentation.
32
+ //
33
+ // "Reserved Font Name" refers to any names specified as such after the
34
+ // copyright statement(s).
35
+ //
36
+ // "Original Version" refers to the collection of Font Software components as
37
+ // distributed by the Copyright Holder(s).
38
+ //
39
+ // "Modified Version" refers to any derivative made by adding to, deleting,
40
+ // or substituting -- in part or in whole -- any of the components of the
41
+ // Original Version, by changing formats or by porting the Font Software to a
42
+ // new environment.
43
+ //
44
+ // "Author" refers to any designer, engineer, programmer, technical
45
+ // writer or other person who contributed to the Font Software.
46
+ //
47
+ // PERMISSION & CONDITIONS
48
+ // Permission is hereby granted, free of charge, to any person obtaining
49
+ // a copy of the Font Software, to use, study, copy, merge, embed, modify,
50
+ // redistribute, and sell modified and unmodified copies of the Font
51
+ // Software, subject to the following conditions:
52
+ //
53
+ // 1) Neither the Font Software nor any of its individual components,
54
+ // in Original or Modified Versions, may be sold by itself.
55
+ //
56
+ // 2) Original or Modified Versions of the Font Software may be bundled,
57
+ // redistributed and/or sold with any software, provided that each copy
58
+ // contains the above copyright notice and this license. These can be
59
+ // included either as stand-alone text files, human-readable headers or
60
+ // in the appropriate machine-readable metadata fields within text or
61
+ // binary files as long as those fields can be easily viewed by the user.
62
+ //
63
+ // 3) No Modified Version of the Font Software may use the Reserved Font
64
+ // Name(s) unless explicit written permission is granted by the corresponding
65
+ // Copyright Holder. This restriction only applies to the primary font name as
66
+ // presented to the users.
67
+ //
68
+ // 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69
+ // Software shall not be used to promote, endorse or advertise any
70
+ // Modified Version, except to acknowledge the contribution(s) of the
71
+ // Copyright Holder(s) and the Author(s) or with their explicit written
72
+ // permission.
73
+ //
74
+ // 5) The Font Software, modified or unmodified, in part or in whole,
75
+ // must be distributed entirely under this license, and must not be
76
+ // distributed under any other license. The requirement for fonts to
77
+ // remain under this license does not apply to any document created
78
+ // using the Font Software.
79
+ //
80
+ // TERMINATION
81
+ // This license becomes null and void if any of the above conditions are
82
+ // not met.
83
+ //
84
+ // DISCLAIMER
85
+ // THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86
+ // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87
+ // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88
+ // OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89
+ // COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90
+ // INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91
+ // DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92
+ // FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93
+ // OTHER DEALINGS IN THE FONT SOFTWARE.
94
+
95
+ @font-face {
96
+ font-family: "Quicksand";
97
+ src: url("/assets/webfonts/Quicksand-Medium.ttf") format("truetype"),
98
+ url("/assets/webfonts/Quicksand-Medium.woff2") format("woff2");
99
+ font-weight: normal;
100
+ }
101
+
102
+ @font-face {
103
+ font-family: "Quicksand";
104
+ src: url("/assets/webfonts/Quicksand-Bold.ttf") format("truetype"),
105
+ url("/assets/webfonts/Quicksand-Bold.woff2") format("woff2");
106
+ font-weight: bold;
107
+ }
data/_sass/main.scss ADDED
@@ -0,0 +1,309 @@
1
+ html {
2
+ --main-background-color: #ffffff;
3
+ --secondary-background-color: #f4e3d7;
4
+ --main-text-color: #502d16;
5
+ --secondary-text-color: #784421;
6
+ --lighten-text-1-color: #a05a2c;
7
+ --lighten-text-2-color: #c87137;
8
+ --lighten-text-3-color: #d38d5f;
9
+ --lighten-text-4-color: #deaa87;
10
+ height: 100%;
11
+ }
12
+
13
+ body {
14
+ background-color: var(--main-background-color) !important;
15
+ color: var(--main-text-color) !important;
16
+ font-family: "Quicksand", sans-serif;
17
+ height: 100%;
18
+ line-height: 1.6rem;
19
+ margin: 0;
20
+ padding: 1rem;
21
+ }
22
+
23
+ .container {
24
+ position: relative;
25
+ max-width: 100vw;
26
+ margin: 0 auto;
27
+ margin-top: 4rem;
28
+ margin-bottom: 4rem;
29
+ }
30
+
31
+ .container:after {
32
+ content: "";
33
+ display: table;
34
+ clear: both;
35
+ }
36
+
37
+ .container #table-of-contents {
38
+ position: fixed;
39
+ float: left;
40
+ left: 2vw;
41
+ overflow-x: scroll;
42
+ overflow-y: scroll;
43
+ width: 20vw;
44
+ height: calc(100vh - 15rem);
45
+ }
46
+
47
+ .container #content {
48
+ position: absolute;
49
+ right: 2vw;
50
+ float: left;
51
+ width: 72vw;
52
+ margin-left: 1rem;
53
+ padding-bottom: 10rem;
54
+ }
55
+
56
+ h1 {
57
+ line-height: 2rem;
58
+ }
59
+
60
+ h1, h2, h3 {
61
+ font-weight: bold;
62
+ border-top: 2px var(--secondary-background-color) solid;
63
+ padding: 1rem 0;
64
+ }
65
+
66
+ .back-to-top {
67
+ position: fixed;
68
+ display: flex;
69
+ justify-content: center;
70
+ align-items: center;
71
+ right: 0;
72
+ bottom: 0;
73
+ margin: 1rem;
74
+ padding: 1rem;
75
+ background-color: var(--secondary-background-color);
76
+ border: 1px var(--secondary-text-color) dotted;
77
+ border-radius: 50%;
78
+ width: 2rem;
79
+ height: 2rem;
80
+ text-decoration: none;
81
+ color: var(--secondary-text-color);
82
+ z-index: 99999;
83
+ }
84
+
85
+ .back-to-top:hover {
86
+ color: var(--lighten-text-1-color);
87
+ }
88
+
89
+ @media screen and (max-width: 600px) and (orientation: portrait) {
90
+ .container {
91
+ position: initial !important;
92
+ width: 100%;
93
+ margin-bottom: 1rem;
94
+ }
95
+
96
+ .container #table-of-contents {
97
+ position: initial !important;
98
+ width: 100%;
99
+ height: initial !important;
100
+ }
101
+
102
+ .container #content {
103
+ position: initial !important;
104
+ width: 100%;
105
+ margin-left: 0;
106
+ padding-bottom: 1rem;
107
+ }
108
+
109
+ .back-to-top {
110
+ width: 0.8rem;
111
+ height: 0.8rem;
112
+ }
113
+
114
+ .back-to-top i {
115
+ font-size: 0.8rem;
116
+ }
117
+ }
118
+
119
+ /***
120
+ Navigation
121
+ ***/
122
+ .top-nav {
123
+ position: fixed;
124
+ background-color: var(--secondary-background-color) !important;
125
+ overflow: hidden;
126
+ top: 0;
127
+ left: 0;
128
+ right: 0;
129
+ margin-bottom: 0.5rem;
130
+ padding: 0.5rem;
131
+ width: 100%;
132
+ z-index: 9999;
133
+ }
134
+
135
+ .top-nav a {
136
+ float: left;
137
+ display: block;
138
+ color: var(--main-text-color);
139
+ text-align: center;
140
+ padding: 1rem;
141
+ text-decoration: none;
142
+ }
143
+
144
+ .top-nav a:hover {
145
+ color: var(--lighten-text-1-color);
146
+ }
147
+
148
+ .top-nav a.current {
149
+ background-color: var(--main-background-color) !important;
150
+ color: var(--secondary-text-color);
151
+ }
152
+
153
+ .top-nav a.icon {
154
+ display: none;
155
+ }
156
+
157
+ @media screen and (max-width: 600px) and (orientation: portrait) {
158
+ .top-nav a:not(:first-child) {
159
+ display: none;
160
+ }
161
+
162
+ .top-nav a.icon {
163
+ float: right;
164
+ margin-right: 1rem;
165
+ right: 0.5rem;
166
+ display: block;
167
+ }
168
+
169
+ .top-nav.responsive {
170
+ width: 100%;
171
+ }
172
+
173
+ .top-nav.responsive a.icon {
174
+ position: absolute;
175
+ margin-right: 1rem;
176
+ top: 0.5rem;
177
+ right: 0.5rem;
178
+ }
179
+
180
+ .top-nav.responsive a {
181
+ float: none;
182
+ display: block;
183
+ text-align: left;
184
+ }
185
+
186
+ .top-nav a.current {
187
+ margin-right: 1rem;
188
+ }
189
+ }
190
+
191
+ /***
192
+ TOC
193
+ ***/
194
+
195
+ #table-of-contents ul {
196
+ padding-inline-start: 22px;
197
+ }
198
+
199
+ #table-of-contents a {
200
+ text-decoration: none;
201
+ color: var(--secondary-text-color);
202
+ }
203
+
204
+ #table-of-contents a:hover {
205
+ color: var(--lighten-text-1-color);
206
+ }
207
+
208
+ @media screen and (max-width: 600px) and (orientation: portrait) {
209
+ #table-of-contents ul {
210
+ padding-inline-start: 30px;
211
+ }
212
+ }
213
+
214
+ /***
215
+ Content
216
+ ***/
217
+ #content div.highlighter-rouge {
218
+ background-color: var(--secondary-background-color);
219
+ opacity: 0.6;
220
+ padding: 1rem;
221
+ border-radius: 5px;
222
+ }
223
+
224
+ #content code.highlighter-rouge {
225
+ background-color: var(--secondary-background-color);
226
+ opacity: 0.6;
227
+ padding: 4px 6px;
228
+ border-radius: 5px;
229
+ }
230
+
231
+ #content .highlighter-rouge pre.highlight {
232
+ overflow: scroll;
233
+ }
234
+
235
+ #content table {
236
+ overflow-x: scroll;
237
+ }
238
+
239
+ #content table,
240
+ #content th,
241
+ #content td {
242
+ border: 1px var(--main-text-color) solid;
243
+ border-collapse: collapse;
244
+ padding: 1rem;
245
+ }
246
+
247
+ #content th {
248
+ background-color: var(--secondary-background-color);
249
+ }
250
+
251
+ #content a {
252
+ text-decoration: none;
253
+ color: var(--secondary-text-color);
254
+ }
255
+
256
+ #content a:hover {
257
+ color: var(--lighten-text-1-color);
258
+ }
259
+
260
+ /***
261
+ Footer
262
+ ***/
263
+ .site-footer {
264
+ position: fixed;
265
+ bottom: 0;
266
+ left: 0;
267
+ right: 0;
268
+ margin-top: 4rem;
269
+ padding: 1rem 0 1rem 0;
270
+ width: 100%;
271
+ background-color: var(--secondary-background-color);
272
+ text-align: center;
273
+ font-size: 0.8rem;
274
+ z-index: 9999;
275
+ }
276
+
277
+ .site-footer .copyright, .socials, .powered-by {
278
+ margin-bottom: 0.5rem;
279
+ }
280
+
281
+ .site-footer .socials a,
282
+ .site-footer .powered-by a {
283
+ text-decoration: none;
284
+ color: var(--secondary-text-color);
285
+ }
286
+
287
+ .site-footer .socials a:hover,
288
+ .site-footer .powered-by a:hover {
289
+ color: var(--lighten-text-1-color);
290
+ }
291
+
292
+ .site-footer .powered-by .link, .divider {
293
+ display: inline-block;
294
+ }
295
+
296
+ @media screen and (max-width: 600px) and (orientation: portrait) {
297
+ .site-footer {
298
+ position: initial !important;
299
+ margin-top: 1rem;
300
+ }
301
+
302
+ .site-footer .powered-by .link {
303
+ display: block;
304
+ }
305
+
306
+ .site-footer .powered-by .divider {
307
+ display: none;
308
+ }
309
+ }
@@ -0,0 +1,8 @@
1
+ ---
2
+ ---
3
+ @import "fontawesome/scss/fontawesome.scss";
4
+ @import "fontawesome/scss/brands.scss";
5
+ @import "fontawesome/scss/solid.scss";
6
+
7
+ @import "fonts";
8
+ @import "main";
data/assets/js/main.js ADDED
@@ -0,0 +1,14 @@
1
+ // Reference: https://www.w3schools.com/howto/howto_js_topnav_responsive.asp
2
+ function toggleMenu() {
3
+ var x = document.getElementById("top-nav");
4
+ if (x.className === "top-nav") {
5
+ x.className += " responsive";
6
+ } else {
7
+ x.className = "top-nav";
8
+ }
9
+ }
10
+
11
+ function selectVersion() {
12
+ var s = document.getElementById("select-version");
13
+ window.location.href = s.value;
14
+ }
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file