/
index.html
1048 lines (960 loc) · 33.2 KB
/
index.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
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:900&display=swap" rel="stylesheet">
<link rel="stylesheet" href="./demo/css/custom_styles.css">
<link rel="stylesheet" href="./dist/css/main.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/5.0.0/normalize.min.css">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" rel="stylesheet">
<title> Essence | A Minimal CSS Framework</title>
</head>
<body>
<header class="text-center vertical-center">
<div class="small-container">
<h1>Essence</h1>
<p>
<p>
Essence is a lightweight CSS boilerplate meant to help you build visually appealing, responsive web apps. By design, it provides you with only what you need without the bloat.
</p>
<!-- Place this tag where you want the button to render. -->
<a class="github-button" href="https://github.com/chrismgonzalez/Essence" data-icon="octicon-star" data-size="large"
data-show-count="true" aria-label="Star chrismgonzalez/Essence on GitHub">Star</a>
<a class="github-button" href="https://github.com/chrismgonzalez" data-size="large" data-show-count="true"
aria-label="Follow @chrismgonzalez on GitHub">Follow @chrismgonzalez</a>
</p>
</div>
</header>
<section class="setup content-section">
<div class="installation small-container">
<h2>Get up and running</h2>
<p>Use one of the two following options for setup and installation</p>
<div class="flex-row padding-top">
<div class="flex-large flex-50">
<img src="demo/img/css3.png" alt="css3 logo" class="logos">
<h4>CSS (Simple)</h4>
<p>Download the stylesheet, link it in the <code>head</code>, and place all custom CSS in a separate stylesheet</p>
</div>
<div class="flex-large flex-50">
<img src="demo/img/sass.png" alt="sass logo" class="logos">
<h4>Sass (recommended)</h4>
<p>Download the source, and setup a Sass workflow with npm scripts</p>
</div>
</div>
</div>
</section>
<aside id="navigation">
<h1>Essence</h1>
<ul class="nav">
<ul>
<li class="title">HTML</li>
<li><a href="#">Containers</a></li>
<li><a href="#">Grid</a></li>
<li><a href="#">Typography</a></li>
<li><a href="#">Buttons</a></li>
<li><a href="#">Forms</a></li>
<li><a href="#">Tables</a></li>
<li><a href="#">Lists</a></li>
<li><a href="#">Code</a></li>
<li><a href="#">Helpers</a></li>
<li class="title">CSS</li>
<li><a href="#">Use</a></li>
<li><a href="#">Config</a></li>
</ul>
</nav>
</aside>
<section class="essence">
<div class="flex-container">
<main class="content" id="main-content">
<div class="medium-container">
<section id="getting-started">
<article>
<h2>HTML Starting Point</h2>
<p>Begin with a basic
<a href="https://en.wikipedia.org/wiki/HTML5">HTML5</a> template that does the following:</p>
<ul>
<li>Sets the
<a href="http://www.w3schools.com/tags/ref_language_codes.asp" target="_blank">default
language</a> and
<a href="https://en.wikipedia.org/wiki/UTF-8">character set</a>.</li>
<li>Uses the latest
<a href="https://msdn.microsoft.com/en-us/library/jj676915(v=vs.85).aspx">Internet Explorer
rendering mode</a>.</li>
<li>Defines the
<a href="https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Viewport_meta_tag">width of the
viewport</a>
to enable responsiveness.</li>
<li>Includes links to the
<a href="https://taniarascia.github.io/primitive/css/main.css" target="_blank">Primitive CSS
file</a>, an
empty JavaScript file, and a Favicon.</li>
</ul>
<pre><code class="language-html"><!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title></title>
<link rel="stylesheet" href="css/main.css">
<link rel="icon" href="images/favicon.png">
</head>
<body></body>
</html></code></pre>
<p>View all HTML5 with Primitive CSS applied to them.</p>
<p>
<a href="https://taniarascia.github.io/html5-test/" class="button">HTML5 Elements Test</a>
</p>
</article>
</section>
</div>
<section id="containers">
<article>
<h2>Containers</h2>
<p>There are three container sizes for content that are centered with left and right padding. Content without a
container
will span the width of the viewport.</p>
<pre><code class="language-html"><div class="small-container">Small</div>
<div class="medium-container">Medium</div>
<div class="container">Large</div></code></pre>
<table>
<thead>
<tr>
<th>Small</th>
<th>Medium</th>
<th>Large</th>
</tr>
</thead>
<tbody>
<tr>
<td>800px</td>
<td>1000px</td>
<td>1200px</td>
</tr>
</tbody>
</table>
</article>
</section>
</div>
<div class="medium-container">
<section id="grid">
<article>
<h2>Grid</h2>
<p>A simple flex grid with two breakpoints.</p>
<pre><code class="language-html"><div class="flex-row">
<div class="flex-small"></div>
<div class="flex-small"></div>
</div>
<div class="flex-row">
<div class="flex-large"></div>
<div class="flex-large"></div>
</div></code></pre>
<div class="flex-row">
<div class="flex-small example">2</div>
<div class="flex-small example">2</div>
</div>
<div class="flex-row">
<div class="flex-large example">2</div>
<div class="flex-large example">2</div>
</div>
</article>
</section>
<section id="typography">
<article>
<h2>Typography</h2>
<p>The font size is set to
<code>1rem</code> on the
<code>html</code> element, so all font sizing will cascade from the root.</p>
<p>Headings all have the same line-height and margins, and only the font size is individually defined.</p>
<h1 style="margin: 1rem 0;">Heading 1</h1>
<h2 style="margin: 1rem 0;">Heading 2</h2>
<h3 style="color:#404040;margin: 1rem 0;">Heading 3</h3>
<h4 style="margin: 1rem 0;">Heading 4</h4>
<h5 style="margin: 1rem 0;">Heading 5</h5>
</article>
<article>
<h3>Blockquote</h3>
<p>Blockquote is set to have a left border, with the browser default padding removed. A
<code>cite</code> will be right aligned and italicized.
<pre><code class="language-html"><blockquote>
<p>Keep it secret. Keep it safe.</p>
<cite>Gandalf the Gray</cite>
</blockquote></code></pre>
<blockquote>
<p>Keep it secret. Keep it safe.</p>
<cite>Gandalf the Gray</cite>
</blockquote>
</article>
</section>
<section id="buttons">
<article>
<h2>Buttons</h2>
<p>Button elements, links with a
<code>button</code> class, and input elements should all render exactly the same.</p>
<pre><code class="language-html"><button>Button</button>
<input type="submit" value="Submit">
<input type="button" value="Input">
<a class="button">Link</a></code></pre>
<button>Button</button>
<input type="submit" value="Submit">
<input type="button" value="Input">
<a class="button">Link</a>
</article>
<article>
<h3>Accent Buttons</h3>
<p>Adding an
<code>accent-button</code> class will display a secondary color.</p>
<pre><code class="language-html"><button class="accent-button">Button</button></code></pre>
<button class="accent-button">Button</button>
<input type="submit" value="Submit" class="accent-button">
<input type="button" value="Input" class="accent-button">
<a class="button accent-button">Link</a>
</article>
<article>
<h3>Muted Buttons</h3>
<p>Adding a
<code>muted-button</code> class will create ghost/outline buttons.</p>
<pre><code class="language-html"><button class="muted-button">Button</button></code></pre>
<button class="muted-button">Button</button>
<input type="submit" value="Submit" class="muted-button">
<input type="button" value="Input" class="muted-button">
<a class="muted-button button">Link</a>
</article>
<article>
<h3>Round Buttons</h3>
<p>Adding a
<code>round-button</code> class will create rounded buttons.</p>
<pre><code class="language-html"><button class="round-button">Button</button></code></pre>
<button class="round-button">Button</button>
<input type="submit" value="Submit" class="round-button">
<input type="button" value="Input" class="round-button">
<a class="round-button button">Link</a>
</article>
<article>
<h3>Square Buttons</h3>
<p>Adding a
<code>square-button</code> class will create square buttons.</p>
<pre><code class="language-html"><button class="square-button">Button</button></code></pre>
<button class="square-button">Button</button>
<input type="submit" value="Submit" class="square-button">
<input type="button" value="Input" class="square-button">
<a class="square-button button">Link</a>
</article>
<article>
<h3>Full Width Buttons</h3>
<p>Adding a
<code>full-button</code> class will create full-width, block level buttons. Button styles can be combined.</p>
<pre><code class="language-html"><button class="full-button">Button</button></code></pre>
<button class="full-button">Button</button>
<input type="submit" value="Submit" class="full-button accent-button square-button">
<input type="button" value="Input" class="full-button round-button">
<a class="full-button muted-button button">Link</a>
</article>
</section>
<section id="forms">
<article>
<h2>Forms</h2>
<p>Default forms will have full-width, block level labels, inputs, selects, and textareas.</p>
<pre><code class="language-html"><form>
<label for="name">Name</label>
<input type="text" id="name" placeholder="First Name">
<label for="choose">Select</label>
<select id="choose">
<option disabled selected>Please select</option>
<option value="option-1">Option 1</option>
<option value="option-2">Option 2</option>
</select>
<label for="comments">Additional Comments</label>
<textarea id="comments"></textarea>
<label>
<input type="checkbox">
Remember me
</label>
<input type="submit" value="Submit">
</form></code></pre>
<form>
<label for="name">Name</label>
<input type="text" id="name" placeholder="First Name">
<label for="email">Email</label>
<input type="email" id="email" placeholder="Email address">
<label for="choose">Select</label>
<select id="choose">
<option disabled selected>Please select</option>
<option value="option-1">Option 1</option>
<option value="option-2">Option 2</option>
</select>
<label for="comments">Additional Comments</label>
<textarea id="comments"></textarea>
<label>
<input type="checkbox"> Remember me
</label>
<input type="button" value="Submit">
</form>
</article>
<article>
<h3>Form Validation</h3>
<p>An input field with a
<code>has-error</code> class.</p>
<pre><code class="language-html"><input type="text" id="name" placeholder="Name" class="has-error"></code></pre>
<form>
<label for="name-error">Name</label>
<input type="text" id="name-error" placeholder="Name" class="has-error">
</form>
</article>
</section>
<section id="tables">
<article>
<h2>Tables</h2>
<p>Tables are set to a width of 100%, with a bottom border and bold headings.</p>
<pre><code class="language-html"><table>
<thead>
<tr>
<th>Head 1</th>
<th>Head 2</th>
<th>Head 3</th>
</tr>
</thead>
<tfoot>
<tr>
<th>Footer 1</th>
<th>Footer 2</th>
<th>Footer 3</th>
</tr>
</tfoot>
<tbody>
<tr>
<td>Description 1</td>
<td>Description 2</td>
<td>Description 3</td>
</tr>
<tr>
<td>Description 1</td>
<td>Description 2</td>
<td>Description 3</td>
</tr>
<tr>
<td>Description 1</td>
<td>Description 2</td>
<td>Description 3</td>
</tr>
</tbody>
</table></code></pre>
<table>
<thead>
<tr>
<th>Head 1</th>
<th>Head 2</th>
<th>Head 3</th>
</tr>
</thead>
<tfoot>
<tr>
<th>Footer 1</th>
<th>Footer 2</th>
<th>Footer 3</th>
</tr>
</tfoot>
<tbody>
<tr>
<td>Description 1</td>
<td>Description 2</td>
<td>Description 3</td>
</tr>
<tr>
<td>Description 1</td>
<td>Description 2</td>
<td>Description 3</td>
</tr>
<tr>
<td>Description 1</td>
<td>Description 2</td>
<td>Description 3</td>
</tr>
</tbody>
</table>
</article>
<article>
<h3>Striped Tables</h3>
<p>Add a
<code>striped</code> class for alternating row background colors.</p>
<pre><code class="language-html"><table class="striped-table">
<!-- etc -->
</table></code></pre>
<table class="striped-table">
<thead>
<tr>
<th>Head 1</th>
<th>Head 2</th>
<th>Head 3</th>
</tr>
</thead>
<tbody>
<tr>
<td>Description 1</td>
<td>Description 2</td>
<td>Description 3</td>
</tr>
<tr>
<td>Description 1</td>
<td>Description 2</td>
<td>Description 3</td>
</tr>
<tr>
<td>Description 1</td>
<td>Description 2</td>
<td>Description 3</td>
</tr>
</tbody>
</table>
</article>
<article>
<h3>Contained Tables</h3>
<p>Wrap the table in a
<code>contain-table</code> class to prevent tables with a lot of content from stretching on small screens.</p>
<pre><code class="language-html"><div class="contain-table">
<table>
<!-- etc -->
</table>
</div></code></pre>
<div class="contain-table">
<table>
<thead>
<tr>
<th>Head 1</th>
<th>Head 2</th>
<th>Head 3</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://taniarascia.github.io/primitive">https://taniarascia.github.io/primitive</a>
</td>
<td>Description 2</td>
<td>Description 3</td>
</tr>
<tr>
<td>Description 1</td>
<td>Description 2</td>
<td>Description 3</td>
</tr>
</tbody>
<tfoot>
<tr>
<td>Footer 1</td>
<td>Footer 2</td>
<td>Footer 3</td>
</tr>
</tfoot>
</table>
</div>
</article>
</section>
<section id="lists">
<article>
<h2>Lists</h2>
<p>Regular ordered and unordered lists have no special styling applied to them.</p>
<pre><code class="language-html"><ul>
<li>List item one
<ul>
<li>Nested list item</li>
</ul>
</li>
<li>List item two</li>
<li>List item three</li>
</ul></code></pre>
<div class="row">
<div class="large-50">
<ul>
<li>List item one
<ul>
<li>Nested list item </li>
</ul>
</li>
<li>List item two</li>
<li>List item three</li>
</ul>
</div>
<div class="large-50">
<ol>
<li>List item one
<ol>
<li>Nested list item</li>
</ol>
</li>
<li>List item two</li>
<li>List item three</li>
</ol>
</div>
</div>
</article>
<article>
<h3>Definition Lists</h3>
<p>Definition titles are bold, and margins have been placed after each description.</p>
<pre><code class="language-html"><dl>
<dt>Definition Title One</dt>
<dd>First definition description</dd>
<dt>Definition Title Two</dt>
<dd>First definition description</dd>
</dl></code></pre>
<dl>
<dt>Definition Title One</dt>
<dd>First definition description</dd>
<dt>Definition Title Two</dt>
<dd>First definition description</dd>
</dl>
</article>
</section>
<section id="code">
<article>
<h2>Code</h2>
<p>Style has been added for inline
<code><code></code> tags, and
<code><kbd></code> is a
<kbd>keyboard input</kbd>. </p>
<o>Place blocks of preformatted code in a
<code><pre><code></code>.</p>
<pre><code>class Voila {
public:
// Voila
static const string VOILA = "Voila";
}</code></pre>
</article>
</section>
<section id="helpers">
<article>
<h2>Helpers</h2>
<p>Helper classes are helpful for templating.</p>
</article>
<article>
<h3>Vertical Center</h3>
<p>Vertically center an element with the
<code>vertical-center</code> class. (Uses
<a href="http://caniuse.com/#search=flexbox" target="_blank">Flexbox</a>.)</p>
<pre><code class="language-html"><div class="vertical-center">
<div>Vertically centered</div>
</div></code></pre>
<div class="vertical-center example" style="height: 100px;">
<div class="example">Vertically centered</div>
</div>
</article>
<article>
<h3>Text Alignment</h3>
<p>Use
<code>text-left</code>,
<code>text-right</code>, and
<code>text-center</code> to align content.</p>
<pre><code class="language-html"><p class="text-left">Left</p>
<p class="text-center">Center</p>
<p class="text-right">Right</p></code></pre>
<p class="text-left">
<span class="example" style="padding: 5px;">Left</span>
</p>
<p class="text-center">
<span class="example" style="padding: 5px;">Center</span>
</p>
<p class="text-right">
<span class="example" style="padding: 5px;">Right</span>
</p>
</article>
<article>
<h3>Screen Reader Text</h3>
<p>Accessibility is important - if you have a label that should be hidden but accessible, or use an icon as a
link, or
want to skip navigation, use the
<code>screen-reader-text</code> class to hide content visually.
<pre><code class="language-html"><a class="screen-reader-text" href="#content">Skip Navigation</a></code></pre>
</article>
<article>
<h3>Responsive Images</h3>
<p>Add a
<code>responsive-image</code> class for responsive images.</p>
<pre><code class="language-html"><img src="#" class="responsive-image" alt="Responsive Image"></code></pre>
<img src="https://placehold.it/1000x100" class="responsive-image" alt="Example of responsive-image CSS class">
</article>
<article>
<h3>More Helper Classes</h3>
<table>
<thead>
<tr>
<th>Class</th>
<th>What it does</th>
</tr>
</thead>
<tr>
<td>
<code>.float-left</code>
</td>
<td>
<code>float: left</code>
</td>
</tr>
<tr>
<td>
<code>.float-right</code>
</td>
<td>
<code>float: right</code>
</td>
</tr>
<tr>
<td>
<code>.block</code>
</td>
<td>
<code>display: block</code>
</td>
</tr>
<tr>
<td>
<code>.inline-block</code>
</td>
<td>
<code>display: inline-block</code>
</td>
</tr>
<tr>
<td>
<code>.inline</code>
</td>
<td>
<code>display: inline</code>
</td>
</tr>
<tr>
<td>
<code>.show</code>
</td>
<td>
<code>display: block !important</code>
</td>
</tr>
<tr>
<td>
<code>.hide</code>
</td>
<td>
<code>display: none !important</code>
</td>
</tr>
<tr>
<td>
<code>.padding-top</code>
</td>
<td>
<code>padding-top: 2rem</code>
</td>
</tr>
<tr>
<td>
<code>.no-padding-top</code>
</td>
<td>
<code>padding-top: 0</code>
</td>
</tr>
<tr>
<td>
<code>.padding-bottom</code>
</td>
<td>
<code>padding-bottom: 2rem</code>
</td>
</tr>
<tr>
<td>
<code>.no-padding-bottom</code>
</td>
<td>
<code>padding-bottom: 0</code>
</td>
</tr>
<tr>
<td>
<code>.margin-top</code>
</td>
<td>
<code>margin-top: 2rem</code>
</td>
</tr>
<tr>
<td>
<code>.no-margin-top</code>
</td>
<td>
<code>margin-top: 0</code>
</td>
</tr>
<tr>
<td>
<code>.margin-bottom</code>
</td>
<td>
<code>margin-bottom: 2rem</code>
</td>
</tr>
<tr>
<td>
<code>.no-margin-bottom</code>
</td>
<td>
<code>margin-bottom: 0</code>
</td>
</tr>
<tr>
<td>
<code>.content-section</code>
</td>
<td>
<code>padding: 60px 0</code> (30px on mobile)</td>
</tr>
</table>
</article>
</section>
<section id="sass-main">
<article>
<h2>Sass</h2>
<p>This project is built with Sass (SCSS) and npm scripts. If you're not familiar with these technologies, please
read the tutorials
below.</p>
<ul>
<li>
<a href="https://www.taniarascia.com/learn-sass-now/" target="_blank">Learn to use Sass</a>
</li>
<li>
<a href="https://www.taniarascia.com/how-to-install-and-use-node-js-and-npm-mac-and-windows/" targer="_blank">Learn
to use Node.js/npm</a>
</li>
</ul>
<p>Sass is used to extend your CSS, allowing you to use useful concepts like variables and nesting, as well as
compartmentalizing
and organizing the code. Npm is used to watch for changes and process those Sass files into regular CSS files,
as
well as minifying and adding prefixes for cross-browser compatibilty.</p>
<p>If you already have Node installed, you can just clone the project...</p>
<pre><code>git clone https://github.com/taniarascia/primitive.git</code></pre>
<p>install the dev dependencies in the root of the project...</p>
<pre><code>npm install</code></pre>
<p>and run.</p>
<pre><code>npm run sass</code></pre>
</article>
<article>
<h3>Directory Structure</h3>
<p>The project contains the source and destination folders, as well as a few necessary project files.</p>
<ul>
<li>
<strong>dist</strong> - the distribution folder that contains the final CSS, JavaScript, and HTML output.</li>
<li>
<strong>src</strong> - the source folder that contains all the
<code>scss</code> files and folders.</li>
<li>
<strong>.gitignore</strong> - ignore
<code>node_modules</code> and
<code>.sass-cache</code> files.
<li>
<strong>package.json</strong> - npm package folder to initialize
<code>node_modules</code>
</li>
</ul>
<pre>dist/
├── css/
│ ├── main.css
│ └── main.css.map
├── js/
│ └── script.js
├── images/
│ └── favicon.png
├── index.html
src/
└── scss/
├── base/
│ ├── _mixins.scss
│ ├── _normalize.scss
│ ├── _reset.scss
│ └── _variables.scss
└── components/
├── _scaffolding.scss
├── _grid.scss
├── _helpers.scss
├── _buttons.scss
├── _forms.scss
├── _tables.scss
├── _navigation.scss
└── _layout.scss
main.scss
.gitignore
LICENSE.md
README.md
package-lock.json
package.json</pre>
</article>
<article>
<h3>Main Sass File</h3>
<p>In the main Sass file,
<strong>main.scss</strong>, we'll pull in the configuration (variables and mixins) first, followed by resets,
then all the
components.</p>
<pre><code class="language-scss">// Configuration
@import "base/variables";
@import "base/mixins";
// Reset
@import "base/normalize";
@import "base/reset";
// Components
@import "components/scaffolding";
@import "components/grid";
@import "components/helpers";
@import "components/buttons";
@import "components/forms";
@import "components/tables";
@import "components/navigation";
@import "components/layout";</code></pre>
<p>Most of the components should be self-explanatory.
<strong>Scaffolding</strong> is the main styling of typography, links, headings, etc.
<strong>Navigation</strong> and
<strong>layout</strong> are empty files, but I kept them in because they're generally necessary. Add more files
as necessary
(3rd party, fonts, etc).</p>
</article>
</section>
<section id="sass-config">
<article>
<h2>Configuration</h2>
<p>Much of the design can be configured just by changing some settings in
<strong>_variables.scss</strong>. This file will define your colors, typography, sizes, breakpoints, buttons,
borders, and
more. Define all your variables here to keep your project organized.</p>
<pre><code class="language-scss">/* Variables
* ===============
*
* All variables and most of the configuration is defined on this page. */
/* Containers */
$x-small: 600px;
$small: 800px;
$medium: 1000px;
$large: 1200px;
/* Breakpoints */
$mobile: $x-small;
$desktop: $medium;
/* Colors */
$background: white;
$primary-color: #0366EE;
$secondary-color: #FCB42A;
$accent-color: #cdcdcd;
$alternate-background: #fafafa;
$alternate-color: #404040;
$link-color: $primary-color;
$link-hover-color: darken($link-color, 15%);
$highlight: #ffeea8;
$error: #D33C40;
$bq-border: 16px solid #f0f0f0;
/* Typography */
// Body font
$font-size: 1rem;
$body-font-size: 1rem;
$font-style: normal;
$font-variant: normal;
$font-weight: normal;
$font-color: #404040;
$font-family: -apple-system, BlinkMacSystemFont, Helvetica Neue, Helvetica, Arial, sans-serif;
$line-height: 1.6;
// Headings
$heading-font-color: #404040;
$heading-font-weight: 600;
$heading-font-family: -apple-system, BlinkMacSystemFont, Helvetica Neue, Helvetica, Arial, sans-serif;
$heading-line-height: 1.2;
// Mobile heading font size
$h1-mobile: 1.75rem;
$h2-mobile: 1.5rem;
$h3-mobile: 1.25rem;
$h4-mobile: 1.1rem;
$h5-mobile: 1rem;
// Heading font size
$h1: 2.25rem;
$h2: 2rem;
$h3: 1.75rem;
$h4: 1.5rem;
$h5: 1.25rem;
/* Padding */
$padding: 1rem;
$margins: 1.5rem;
$content-padding: 60px 0;
$content-padding-mobile: 30px 0;
/* Borders */
$border-width: 1px;
$border-style: solid;
$border-color: #dedede;
$border-radius: 4px;
$borders: $border-width $border-style $border-color;
/* Buttons */
$button-background: $primary-color;
$button-background-hover: darken($button-background, 10%);
$button-color: #ffffff;
$button-font-weight: 600;
$button-font-family: -apple-system, BlinkMacSystemFont, Helvetica Neue, Helvetica, Arial, sans-serif;
$button-font-size: 1rem;
$button-border-width: 1px;
$button-border-style: solid;
$button-border-color: $button-background;
$button-border-radius: $border-radius;
$button-text-transform: none;
// Accent buttons
$accent-button-background: $secondary-color;
$accent-button-color: #ffffff;
$accent-button-color-hover: #ffffff;
// Muted Buttons
$muted-border: 1px solid $accent-color;
$muted-border-hover: 1px solid darken($accent-color, 30%);
$muted-background: transparent;
$muted-background-hover: transparent;
$muted-color: darken($accent-color, 50%);
$muted-color-hover: darken($accent-color, 50%);
// Round Buttons
$round-buttons: 40px;
/* Forms */
$forms: ('[type=color], [type=date], [type=datetime], [type=datetime-local], [type=email], [type=month], [type=number], [type=password], [type=search], [type=tel], [type=text], [type=url], [type=week], [type=time], select, textarea');
$buttons: ('.button, a.button, button, [type=submit], [type=reset], [type=button]');
$input-background: transparent;