-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocumentation.html
544 lines (538 loc) · 20.1 KB
/
documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<link rel="stylesheet" href="./src/styles/bootstrap.min.css" />
<link rel="stylesheet" href="./src/styles/style.min.css" />
<meta
name="viewport"
content="width=device-width, initial-scale=1, shrink-to-fit=no, user-scalable=0"
/>
<link
rel="apple-touch-icon"
sizes="180x180"
href="./src/media/icons/apple-touch-icon.png"
/>
<link
rel="icon"
type="image/png"
sizes="32x32"
href="./src/media/icons/favicon-32x32.png"
/>
<link
rel="icon"
type="image/png"
sizes="16x16"
href="./src/media/icons/favicon-16x16.png"
/>
<title>Documentation</title>
<meta name="color-scheme" content="dark light" />
<meta name="author" content="Aleksey Vratsky" />
<meta name="copyright" content="Aleksey Vratsky" />
<link
name="description"
content="Junior front-end developer from Ukraine."
/>
<link
name="keywords"
content="front-end,developer,development,website,buy website,create online shop"
/>
</head>
<body class="page dark">
<!-- NavBar -->
<nav class="navbar navbar-dark div-bg">
<div class="container-fluid">
<div class="justify-content-start space-little-left">
<a class="navbar-brand" href="./">Aleksey Vratsky</a>
</div>
<ul
data-da=".offcanvas-body, 991.98, first"
class="navbar-nav desktop-nav row-menu visibility-desktop-menu"
>
<div class="basis evenly d-flex offcanvas-m">
<li class="nav-item">
<a class="nav-link" href="./services"><h5>Services</h5></a>
</li>
<li class="nav-item">
<a class="nav-link" href="./buy-templates"
><h5>Buy templates</h5></a
>
</li>
<li class="nav-item">
<a class="nav-link" href="./documentation"><h5>Docs</h5></a>
</li>
<li class="nav-item">
<a class="nav-link" href="./donations"><h5>Donations</h5></a>
</li>
</div>
<div class="social border-left-right">
<li class="nav-item d-flex" style="align-items: center">
<a class="nav-link" href="https://t.me/vratsky0" target="_blank">
<img
src="./src/media/icons/telegram.svg"
class="social-telegram space-little-right"
width="30"
height="30"
/>
</a>
<a
class="nav-link"
href="https://www.instagram.com/vratsk1y/"
target="_blank"
>
<img
src="./src/media/icons/instagram.svg"
class="social-instagram"
width="32"
height="32"
/>
</a>
</li>
</div>
<div
data-da=".theme-switch, 991.98, first"
class="form-check form-switch toggle space-little-left"
>
<input
class="form-check-input toggle-input"
type="checkbox"
role="switch"
id="flexSwitchCheckDefault"
/>
<label class="form-check-label" for="flexSwitchCheckDefault">
</label>
</div>
</ul>
<button
class="navbar-toggler visibility-mobile-menu"
type="button"
data-bs-toggle="offcanvas"
data-bs-target="#offcanvasNavbar"
aria-controls="offcanvasNavbar"
>
<span class="navbar-toggler-icon"></span>
</button>
<div
class="offcanvas offcanvas-end blur"
tabindex="-1"
id="offcanvasNavbar"
aria-labelledby="offcanvasNavbarLabel"
>
<div class="offcanvas-header">
<h5 class="offcanvas-title gray-color" id="offcanvasNavbarLabel">
Menu
</h5>
<div class="theme-switch"></div>
<button
type="button"
class="btn-close text-reset gray-color close-btn-canvas"
data-bs-dismiss="offcanvas"
aria-label="Close"
></button>
</div>
<div class="offcanvas-body relative"></div>
</div>
</div>
</nav>
<div
class="col-lg-6 col-md-10 col-sm-12 container-bg-d white-color div-space div-bg"
style="width: 100%"
>
<nav
style="
--bs-breadcrumb-divider: url(
"data:image/svg + xml,
%3Csvgxmlns='http://www.w3.org/2000/svg'width='8'height='8'%3E%3Cpathd='M2.5 0L1 1.5 3.5 4 1 6.5 2.5 8l4-4-4-4z'fill='currentColor'/%3E%3C/svg%3E"
);
margin: 0;
"
aria-label="breadcrumb"
>
<ol class="breadcrumb nullMargin">
<li class="breadcrumb-item"><a href="./">Home</a></li>
<li class="breadcrumb-item active" aria-current="page">
Documentation
</li>
</ol>
</nav>
</div>
<div
class="col-lg-6 col-md-10 col-sm-12 container-bg-d div-space white-color border-top div-bg"
style="width: 100%"
>
<h1 style="padding: 0 !important">
<strong>Documentation</strong>
</h1>
<h4 class="gray-color">
Here you can find full information
<strong class="flag">about this template</strong>
</h4>
</div>
<div class="container-lg">
<!-- Content -->
<div class="row space-top-little white-color div-space">
<div class="row center space-top-little container-bg-d white-color div-space">
<div class="col-lg-8 col-md-8 col-sm-12 space">
<h2 class="space-top"><strong>Requirements</strong></h2>
<h4 class="gray-color space-line">
1.
<strong class="flag">Section</strong>
</h4>
<p class="space-little">
To fully work with this template, make sure you have the following
components installed:
</p>
<li>
<a href="https://nodejs.org/en/" target="_blank">
Node.js
<img src="./src/media/icons/link.svg" width="14" height="14" />
</a>
</li>
<li>
<a href="https://purgecss.com/" target="_blank">
PurgeCss
<img src="./src/media/icons/link.svg" width="14" height="14" />
</a>
</li>
<li>
<a href="https://prepros.io/" target="_blank">
Prepros
<img
src="./src/media/icons/link.svg"
width="14"
height="14"
loading="lazy"
/>
</a>
(or another SASS compiler)
</li>
<h2 class="space-top"><strong>How it works</strong></h2>
<h4 class="gray-color space-line">
2.
<strong class="flag">Section</strong>
</h4>
<p class="space-little">
This template includes
<a href="https://getbootstrap.com/" target="_blank">
Bootstrap
<img src="./src/media/icons/link.svg" width="14" height="14" />
</a>
,
<a href="https://sass-lang.com/" target="_blank">
SASS
<img src="./src/media/icons/link.svg" width="14" height="14" />
</a>
, and JavaScript.
</p>
<h2 class="space-top"><strong>Styles</strong></h2>
<h4 class="gray-color space-line">
3.
<strong class="flag">Section</strong>
</h4>
<p class="space-little">
This template includes few files of styles.
</p>
<h5>For example</h5>
<p>
I need to change all text color of site to white, all i need to do
just going to this file: <code>dark-light.css</code>
</p>
<figure class="figure">
<picture>
<source
srcset="./src/media/images/code.avif"
type="image/avif"
loading="lazy"
/>
<source
srcset="./src/media/images/code.webp"
type="image/webp"
loading="lazy"
/>
<img
src="./src/media/images/code.png"
class="figure-img img-fluid rounded"
width="636"
height="620"
loading="lazy"
/>
</picture>
<figcaption class="figure-caption">
<code>dark-light.css</code>
</figcaption>
</figure>
<p>
As you can see, a different variable for each color, just change
here
<code>--gray-color: #2b2b2b;</code> and changes will applies on
all template. Same with all components in this template.
</p>
<h5>Defaults veriables</h5>
<table class="table dark-bg gray-color custom-table">
<tbody>
<tr class="">
<th scope="row"><code>--gray-color</code></th>
<td>Title and text color</td>
</tr>
<tr class="">
<th scope="row"><code>--white-color</code></th>
<td>Title and text color</td>
</tr>
<tr class="">
<th scope="row"><code>--red-color</code></th>
<td colspan="2">Danger color</td>
</tr>
<tr class="">
<th scope="row"><code>--main-bg-color</code></th>
<td colspan="2">Container background color</td>
</tr>
<tr class="">
<th scope="row"><code>--main-bg-color-darker</code></th>
<td colspan="2">Second container background color</td>
</tr>
<tr class="">
<th scope="row"><code>--first-flag-color</code></th>
<td colspan="2">First flag color</td>
</tr>
<tr class="">
<th scope="row"><code>--second-flag-color</code></th>
<td colspan="2">Second flag color</td>
</tr>
<tr class="">
<th scope="row"><code>--social-bg</code></th>
<td colspan="2">Social link color</td>
</tr>
<tr class="">
<th scope="row"><code>--primary-color</code></th>
<td colspan="2">Accent color</td>
</tr>
<tr class="">
<th scope="row">
<code>--active-main-bg-color-darker</code>
</th>
<td colspan="2">Active background when hover</td>
</tr>
<tr class="">
<th scope="row"><code>--nav-active</code></th>
<td colspan="2">Nav bar hover color</td>
</tr>
<tr class="">
<th scope="row"><code>--background-color</code></th>
<td colspan="2">Main background color</td>
</tr>
<tr class="">
<th scope="row"><code>--nav-bar-bg</code></th>
<td colspan="2">Nav bar background color</td>
</tr>
<tr class="">
<th scope="row"><code>--svg-colors</code></th>
<td colspan="2">SVG colors</td>
</tr>
<tr class="">
<th scope="row"><code>--container-bg</code></th>
<td colspan="2">Another container background color</td>
</tr>
<tr class="">
<th scope="row"><code>--container-bg-d</code></th>
<td colspan="2">Another container background color</td>
</tr>
<tr class="">
<th scope="row"><code>--shadows</code></th>
<td colspan="2">Shadow effect for containers</td>
</tr>
<tr class="">
<th scope="row"><code>--filter</code></th>
<td colspan="2">Filter for images</td>
</tr>
<tr class="">
<th scope="row"><code>--transform</code></th>
<td colspan="2">Transform effect</td>
</tr>
<tr class="">
<th scope="row"><code>--service-image-1</code></th>
<td colspan="2">
URL for images (depends what the style theme user choose)
</td>
</tr>
<tr class="">
<th scope="row"><code>--service-image-2</code></th>
<td colspan="2">
URL for images (depends what the style theme user choose)
</td>
</tr>
<tr class="">
<th scope="row"><code>--service-image-3</code></th>
<td colspan="2">
URL for images (depends what the style theme user choose)
</td>
</tr>
<tr class="">
<th scope="row"><code>--templates-image-1</code></th>
<td colspan="2">
URL for images (depends what the style theme user choose)
</td>
</tr>
</tbody>
</table>
<h2 class="space-top"><strong>Optimization</strong></h2>
<h4 class="gray-color space-line">
4.
<strong class="flag">Section</strong>
</h4>
<p class="space-top-little">
To optimize the site I used PurgeCss, it automatically scans the
css file and removes unused styles, thereby reducing the file
size.
</p>
<p class="space-top-little">
This is done for the file bootstrap.min.css, so new Bootstrap
components you add to the template will not have Bootstrap styles,
you can write your own, but I recommend making a couple of steps
to include Bootstrap styles, and also to optimize the site.
</p>
<ol class="list-group list-group-numbered space-top-little">
<li class="list-group-item dark-bg gray-color">
Make sure
<a href="https://nodejs.org/en/" target="_blank">
Node.js
<img
src="./src/media/icons/link.svg"
width="14"
height="14"
/>
</a>
installed
</li>
<li class="list-group-item dark-bg gray-color">
And also you need to download
<a href="https://getbootstrap.com/" target="_blank">
Bootstrap
<img
src="./src/media/icons/link.svg"
width="14"
height="14"
/>
</a>
</li>
<li class="list-group-item dark-bg gray-color">
Put <code>bootstrap.min.css</code> wich was downloaded to your
project directory and create folder with "result" name
</li>
<li class="list-group-item dark-bg gray-color">
Then you need open terminal, i use
<a href="https://conemu.github.io/" target="_blank"
>ConEmu for windows
<img
src="./src/media/icons/link.svg"
width="14"
height="14"
/>
</a>
</li>
<li class="list-group-item dark-bg gray-color">
Go to your project directory in terminal
</li>
<li class="list-group-item dark-bg gray-color">
And run this command:
</li>
<li class="list-group-item dark-bg gray-color">
<code
>purgecss --css bootstrap.min.css --content * --output
result</code
>
</li>
<li class="list-group-item dark-bg gray-color">
Then you will get in result folder
<code>bootstrap.min.css</code> file wich include only then
styles and contents you use
</li>
</ol>
<h2 class="space-top"><strong>Shop</strong></h2>
<h4 class="gray-color space-line">
5.
<strong class="flag">Section</strong>
</h4>
<p class="space-top-little">
This template connected to
<a href="https://snipcart.com/" target="_blank"
>Snipcart
<img src="./src/media/icons/link.svg" width="14" height="14" />
</a>
eCommerce platform it means if you don't want integrate another
platform, you need to create account there and active your
API-KEYS in this template, also you need to connect payment
gateways to receive transactions, it's simple just few steps and
you ready to get pay from your products.
</p>
<p>
<a href="https://docs.snipcart.com/v3/" target="_blank"
>Here
<img src="./src/media/icons/link.svg" width="14" height="14" />
</a>
you can find full information about SnipCart, API-KEYS and how you
can sell digital goods.
</p>
<h5 class="space-top-little">
How connect API-KEYS to this template
</h5>
<ol class="list-group list-group-numbered space-little">
<li class="list-group-item dark-bg gray-color">
Go to
<a href="https://nodejs.org/en/" target="_blank">
Snipcart
<img
src="./src/media/icons/link.svg"
width="14"
height="14"
/>
</a>
and create your account
</li>
<li class="list-group-item dark-bg gray-color">
Add to account
<a href="https://docs.snipcart.com/v3/" target="_blank"
>BILLING & PAYMENTS
<img
src="./src/media/icons/link.svg"
width="14"
height="14"
/>
</a>
information, then set up
<a href="https://docs.snipcart.com/v3/" target="_blank"
>PAYMENT GATEWAYS
<img
src="./src/media/icons/link.svg"
width="14"
height="14"
/>
</a>
</li>
<li class="list-group-item dark-bg gray-color">
Switch to live mode, and copy your
<a
href="https://app.snipcart.com/dashboard/account/credentials"
target="_blank"
>LIVE API KEY
<img
src="./src/media/icons/link.svg"
width="14"
height="14"
/>
</a>
</li>
<li class="list-group-item dark-bg gray-color">
Then paste API KEY to <code>snipcart.js</code> file
</li>
</ol>
</div>
</div>
</div>
</div>
<!-- scripts -->
<script src="./src/js/theme-switch-dist.js"></script>
<script src="./src/js/dynamic-adapt-dist.js"></script>
<script src="./src/js/bootstrap.bundle.min.js"></script>
</body>
</html>