-
Notifications
You must be signed in to change notification settings - Fork 19
/
index.html
1276 lines (1076 loc) · 41 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 http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="A CSS tool written in Node JS as a command line app or library for the purging, burning, reducing, shortening, compressing, cleaning, trimming and formatting of duplicate, extra, excess or bloated CSS.">
<meta name="keywords" content="css, css-purge, nodejs, CLI, purging css, burning css, reducing css, shortening css, compressing css, cleaning css, trimming css, formatting css, duplicate css, extra css, excess css, bloated CSS.">
<title>CSS-PURGE ~ Helping you burn that extra CSS off</title>
<!-- Add to homescreen for Chrome on Android -->
<meta name="mobile-web-app-capable" content="yes">
<link rel="icon" sizes="192x192" href="assets/images/favicon/android-icon-192x192.png">
<!-- Add to homescreen for Safari on iOS -->
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<meta name="apple-mobile-web-app-title" content="CSS-PURGE">
<link rel="apple-touch-icon-precomposed" href="assets/images/CSS_Purge_Logo_300.png">
<link rel="shortcut icon" href="assets/images/favicon/android-icon-192x192.png">
<link rel="apple-touch-icon" sizes="57x57" href="assets/images/favicon/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="assets/images/favicon/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="assets/images/favicon/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="assets/images/favicon/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="assets/images/favicon/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="assets/images/favicon/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="assets/images/favicon/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="assets/images/favicon/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="assets/images/favicon/apple-icon-180x180.png">
<link rel="icon" type="image/png" sizes="192x192" href="assets/images/favicon/android-icon-192x192.png">
<link rel="icon" type="image/png" sizes="32x32" href="assets/images/favicon/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="96x96" href="assets/images/favicon/favicon-96x96.png">
<link rel="icon" type="image/png" sizes="16x16" href="assets/images/favicon/favicon-16x16.png">
<link rel="manifest" href="assets/images/favicon/manifest.json">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/ms-icon-144x144.png">
<meta name="theme-color" content="#ffffff">
<!-- <meta content="" property="fb:app_id" /> -->
<meta content="CSS-PURGE" property="og:site_name" />
<meta content="website" property="og:type" />
<meta content="http://rbtech.github.io/css-purge" property="og:url" />
<meta content="CSS-PURGE ~ Helping you burn that extra CSS off" property="og:title" />
<meta content="A CSS tool written in Node JS as a command line app or library for the purging, burning, reducing, shortening, compressing, cleaning, trimming and formatting of duplicate, extra, excess or bloated CSS." property="og:description" />
<meta content="http://rbtech.github.io/css-purge/assets/images/CSS_Purge_FB.png" property="og:image" />
<meta content="2017-11-09T19:20:17+0200" property="og:updated_time" />
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-31023632-4"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-31023632-4');
</script>
</head>
<body class="mdl-purge mdl-color--grey-100 mdl-color-text--grey-700 mdl-base">
<div id="layoutHeader" class="mdl-layout mdl-js-layout mdl-layout--fixed-header">
<header class="mdl-layout__header mdl-layout__header--scroll mdl-color--primary">
<div class="mdl-layout--large-screen-only mdl-layout__header-row"></div>
<div class="mdl-layout--large-screen-only mdl-layout__header-row"></div>
<div class="mdl-layout--large-screen-only mdl-layout__header-row"></div>
<div class="mdl-layout--large-screen-only mdl-layout__header-row"></div>
<div class="mdl-layout__tab-bar mdl-js-ripple-effect mdl-color--primary-dark">
<a id="overviewTab" href="#overview" class="mdl-layout__tab is-active">About</a>
<a id="featuresTab" href="#features" class="mdl-layout__tab">Features</a>
<a id="getStartedTab" href="#getStarted" class="mdl-layout__tab">Get Started</a>
<a id="helpTab" href="#help" class="mdl-layout__tab">Help</a>
<a href="https://github.com/rbtech/css-purge/archive/master.zip" class="mdl-button mdl-js-button mdl-button--raised mdl-js-ripple-effect mdl-button--colored mdl-shadow--4dp mdl-color--accent" id="add">
Download
<span class="visuallyhidden">Download</span>
</a>
</div>
</header>
<main id="layoutContent" class="mdl-layout__content">
<div class="mdl-layout__tab-panel is-active" id="overview">
<section class="section--center mdl-grid mdl-grid--no-spacing">
<div class="mdl-card mdl-cell mdl-cell--12-col">
<div class="mdl-card__supporting-text">
<h1 id="jumboName" class="mdl-typography--display-4"><img width="100px" style="vertical-align: -10px" src="assets/images/CSS_Purge_Logo_300.png" alt="CSS-PURGE Logo">CSS-Purge</h1>
<h4 id="mainDescription">A CSS tool written in Node JS as a command line app or library for the purging, burning, reducing, shortening, compressing, cleaning, trimming and formatting of duplicate, extra, excess or bloated CSS, phew!</h4>
</div>
</div>
</section>
<section class="section--center mdl-grid mdl-grid--no-spacing mdl-shadow--2dp">
<header class="section__play-btn mdl-cell mdl-cell--3-col-desktop mdl-cell--2-col-tablet mdl-cell--4-col-phone mdl-color--indigo-100 mdl-color-text--white">
<i class="material-icons" style="font-size:10em">done_all</i>
</header>
<div class="mdl-card mdl-cell mdl-cell--9-col-desktop mdl-cell--6-col-tablet mdl-cell--4-col-phone">
<div class="mdl-card__supporting-text">
<h4>FEATURES</h4>
We started off with removing duplicate CSS rules and now we have grown a more comprehensive list of features.
</div>
<div class="mdl-card__actions">
<button class="underTheHoodLink mdl-button">Read more</button>
</div>
</div>
</section>
<section class="section--center mdl-grid mdl-grid--no-spacing mdl-shadow--2dp">
<div class="mdl-card mdl-cell mdl-cell--12-col">
<div class="mdl-card__supporting-text">
<h4>GET STARTED</h4>
<img width="100%" src="assets/images/get_started.png" alt="Getting Started with CSS-PURGE">
</div>
<div class="mdl-card__actions">
<button class="gettingStartedLink mdl-button">GO GO GO!</button>
</div>
</div>
</section>
<!-- <section class="section--center mdl-grid mdl-grid--no-spacing">
<div class=" mdl-cell mdl-cell--12-col">
</div>
</section> -->
<br />
<br />
</div>
<div class="mdl-layout__tab-panel" id="features">
<section class="section--center mdl-grid mdl-grid--no-spacing">
<div class="mdl-cell mdl-cell--12-col">
<h3>Features</h3>
<br>
<br>
<img width="100%" src="assets/images/under_the_hood.png" alt="Under the hood of CSS-Purge">
<br>
<br>
<h4>Under the hood</h4>
<p>This is what the engine is doing in a nutshell. We have currently categorized everything that we do into a few core groups:</p>
<h5>1. Reduce Rules</h5>
<p>
This is what we do to reduce the number of rules.
</p>
<ul>
<li>Group duplicate rules in the root, @media, @document & @supports</li>
<li>Group selectors by declarations</li>
<li>Remove empty rules in root, @media, @document & @supports</li>
<li>Remove duplicate @charsets and move it to the top</li>
</ul>
<h5>2. Reduce Declarations</h5>
<p>(New!) Group common declarations into parent selectors.</p>
<p>
Group duplicate declarations in root, @media, @document and @supports rules that:
</p>
<ul>
<li>have duplicate values</li>
<li>are on the reduction list of declarations (allows you more control over which declarations get grouped)</li>
<li>are on the reduction list of selectors (allows you more control over which selectors get grouped)</li>
</ul>
<h5>3. Reduce Values</h5>
<p>
We shrink the size of the values where appropriate, this is what we do so far:
</p>
<ul>
<li>Shorten 0 value (e.g. 0px, 00px, 000em -> 0; )</li>
<li>Shorten named, hex, rgb, hsl color values</li>
<li>Shorten property values (font, font-weight, background, margin, padding, list-style, outline, border, border-top, border-right, border-bottom, border-left, border-radius)</li>
</ul>
<h5>4. Trim Filesize</h5>
<p>
We remove everything else that is not necessary in the file for operation:
</p>
<ul>
<li>Trim Comments, Whitespace, Line-breaks</li>
<li>Trim Non-standard Inline Comments</li>
<li>Trim Removed Rules Previous Comment</li>
<li>Trim Last Semi-colon of Rules</li>
</ul>
<h5>5. Format</h5>
<p>
</p>
<ul>
<li>Format font-family (we make sure there are quotes around multi-worded fonts)</li>
<li>Format 4095 rules legacy limit (splits output CSS into multiple files)</li>
</ul>
<h5>6. Special Features</h5>
<p>
</p>
<ul>
<li>Remove unused CSS rules based on HTML</li>
<li>Convert px to rems: font-size (more coming)</li>
</ul>
<br>
<h4>Got some feature requests? Join us for a chat on gitter:<br><br><a class="mdl-button mdl-js-button mdl-button--raised mdl-js-ripple-effect mdl-button--accent" target="_blank" href="https://gitter.im/css-purge">Visit the Community</a></h4>
</div>
</section>
<!-- <section class="section--center mdl-grid mdl-grid--no-spacing">
<div class=" mdl-cell mdl-cell--12-col">
</div>
</section> -->
</div>
<div class="mdl-layout__tab-panel" id="getStarted">
<!-- <section class="section--center mdl-grid mdl-grid--no-spacing">
<div class=" mdl-cell mdl-cell--11-col">
</div>
</section> -->
<section class="section--center mdl-grid mdl-grid--no-spacing">
<div id="leftPanel" class="mdl-cell mdl-cell--11-col">
<h3 id="headerOverview">Overview</h3>
<h5>Purging CSS</h5>
<br>
<p>This is the typical usage scenario, where you may want to purge some CSS from a file(s) or folder(s) or CSS from your workflow (like from <a href="https://gulpjs.com">gulp</a> or <a href="https://gruntjs.com">grunt</a>).</p>
<br>
<img width="95%" src="assets/images/overview1.png" alt="CSS-Purge Overview 1">
<br>
<br>
<br>
<h5>Purging Unused CSS</h5>
<br>
<p>You want to take it a step further by taking your CSS file(s) and reducing it further based on what is used in your HTML file(s).</p>
<br>
<img width="95%" src="assets/images/overview2.png" alt="CSS-Purge Overview 2">
<br>
<br>
<br>
<br>
<h3 id="headerUsage">Usage</h3>
<h4>3 Ways to Use CSS-PURGE</h4>
<ol>
<li><a class="globalLink" href="#getStarted">CLI App</a></li>
<li><a class="localLink" href="#getStarted">Project</a></li>
<li><a class="libraryLink" href="#getStarted">Library</a></li>
</ol>
<br>
<p>Required: <a href="https://nodejs.org" target="_blank">Node JS</a></p>
<br>
<h5 id="headerGlobal">1 - CLI APP</h5>
<img width="99%" src="assets/images/global_cli_ux.jpg" alt="Global Command Line Interface User Experience or Workflow">
<p style="margin-top:5px;">A typical global workflow</p>
<p>CLI App usage is nice for doing something quick everywhere.</p>
<br>
<h6>Install with npm:</h6>
<span class="mdl-list__item-primary-content">
<span class="mdl-chip">
<span class="mdl-chip__text">npm install css-purge -g</span>
</span>
</span>
<br>
<h6>..then run with options:</h6>
<span class="mdl-list__item-primary-content">
<span class="mdl-chip">
<span class="mdl-chip__text">css-purge [CLI Options]</span>
</span>
</span>
<br>
<pre>
CLI Options:
-V: displays the version number
-c "your CSS": direct CSS input
-i "filename/folder name location": CSS file(s) input
-m "filename/folder name/URL location": HTML file(s) input
-o "filename": The new CSS filename to output as
-f "config filename": run with a custom config filename
-d: run with the default config file (config_css.json must exist in folder)
-h: CLI help
</pre>
<br>
<h6>Some example usage:</h6>
<pre><code class="hljs shell">
css-purge -c ".panel { color:red; color: blue; }"
</code></pre>
<p><b>CSS</b> - Purge some CSS and output to terminal</p>
<br>
<pre><code class="hljs shell">
css-purge -i main.css -o main.min.css
</code></pre>
<p><b>CSS file</b> - Purge CSS from main.css and output to main.min.css</p>
<br>
<pre><code class="hljs shell">
css-purge -i main.css -o main.min.css -f myconfig.json
</code></pre>
<p><b>CSS file with Custom Config</b> - Purge CSS from main.css and output to main.min.css using <a class="configHeaderLink" href="#">myconfig.json</a> for configuration</p>
<br>
<pre><code class="hljs shell">
css-purge -i main.css -o main.min.css -m index.html
</code></pre>
<p><b>CSS file with HTML file</b> - Purge CSS from main.css using index.html to compare and output to main.min.css</p>
<br>
<pre><code class="hljs shell">
css-purge -i "main.css, framework.css" -o main.min.css -m "index.html, http://www.mywebsite.com/index.html"
</code></pre>
<p><b>Multiple CSS and HTML files</b> - Purge CSS from main.css and framework.css (in that specific order) using index.html and index.html from www.mywebsite.com to compare and output to main.min.css</p>
<br>
<br>
<br>
<h5 id="headerLocal">2 - Project</h5>
<img width="99%" src="assets/images/local_cli_ux.jpg" alt="Local Command Line Interface User Experience or Workflow">
<p style="margin-top:5px;">A typical local workflow</p>
<p>Project usage is nice for “setting up shop” for a project.</p>
<br>
<h6>Clone with <a href="https://git-scm.com" target="_blank">git</a>/<a target="_blank" href="https://desktop.github.com">GitHub Desktop</a>:</h6>
<span class="mdl-list__item-primary-content">
<span class="mdl-chip">
<span class="mdl-chip__text">git clone https://github.com/rbtech/css-purge.git</span>
</span>
</span>
<h6>or download from: <a href="https://github.com/rbtech/css-purge" target="_blank">https://github.com/rbtech/css-purge</a></h6>
<br>
<h6>Install dependencies:</h6>
<span class="mdl-list__item-primary-content">
<span class="mdl-chip">
<span class="mdl-chip__text">npm install</span>
</span>
</span>
<br>
<br>
<h6>Run:</h6>
<span class="mdl-list__item-primary-content">
<span class="mdl-chip">
<span class="mdl-chip__text">node css-purge [CLI OPTIONS]</span>
</span>
</span>
<br>
<pre>
CLI Options:
-V: displays the version number
-c "your CSS": direct CSS input
-i "filename/folder name location": CSS file(s) input
-m "filename/folder name/URL location": HTML file(s) input
-o "filename": The new CSS filename to output as
-f "config filename": run with a custom config filename
-d: run with the default config file (config_css.json must exist in folder)
-h: CLI help
</pre>
<br>
<h6>Some example usage:</h6>
<pre><code class="hljs shell">
node css-purge -d
</code></pre>
<p><b>Config</b> - Purge using the default config file (config_css.json)</p>
<br>
<pre><code class="hljs shell">
node css-purge -c ".panel { color:red; color: blue; }"
</code></pre>
<p><b>CSS</b> - Purge some CSS and output to terminal</p>
<br>
<pre><code class="hljs shell">
node css-purge -i main.css -o main.min.css
</code></pre>
<p><b>CSS file</b> - Purge CSS from main.css and output to main.min.css</p>
<br>
<pre><code class="hljs shell">
node css-purge -i main.css -o main.min.css -f myconfig.json
</code></pre>
<p><b>CSS file with Custom Config</b> - Purge CSS from main.css and output to main.min.css using <a class="configHeaderLink" href="#">myconfig.json</a> for configuration</p>
<br>
<pre><code class="hljs shell">
node css-purge -i main.css -o main.min.css -m index.html
</code></pre>
<p><b>CSS file with HTML file</b> - Purge CSS from main.css using index.html to compare and output to main.min.css</p>
<br>
<pre><code class="hljs shell">
node css-purge -i "main.css, framework.css" -o main.min.css -m "index.html, http://www.mywebsite.com/index.html"
</code></pre>
<p><b>Multiple CSS and HTML files</b> - Purge CSS from main.css and framework.css (in that specific order) using index.html and index.html from www.mywebsite.com to compare and output to main.min.css</p>
<br>
<br>
<br>
<br>
<br>
<h5 id="headerLibrary">3 - Library</h5>
<p>Libraries help share the awesomeness to more people :)</p>
<br>
You can test out the library in your browser <a href="https://npm.runkit.com/css-purge" target="_blank">here with RunKit</a>.
<br>
<h6>Install:</h6>
<span class="mdl-list__item-primary-content">
<span class="mdl-chip">
<span class="mdl-chip__text">npm install css-purge --save</span>
</span>
</span>
<br>
<br>
<h6>Some example usage:</h6>
<pre><code class="hljs javascript">
var cssPurge = require('css-purge');
//purging a CSS string with options
var css = "p { color: blue; color: blue; } ";
cssPurge.purgeCSS(css, {
trim : true,
shorten : true
}, function(error, result){
if (error)
console.log(error)
else
console.log('Output CSS: ', result);
});
//uses default settings that are set in the config file
//make sure that css is set
cssPurge.purgeCSSFiles();
//purging a CSS file
cssPurge.purgeCSSFiles({
css:'demo/test1.css'
});
//purging a CSS file with HTML
cssPurge.purgeCSSFiles({
css: 'demo/test1.css',
html: 'demo/html/test1.html'
});
//purging a CSS file with HTML and options
cssPurge.purgeCSSFiles({
css_output: 'test1.min.css',
css: 'demo/test1.css',
html: 'demo/html/test1.html',
trim : true,
shorten : true,
verbose : true
});
//purging a CSS file with HTML, options and config
cssPurge.purgeCSSFiles({
css_output: 'test1.min.css',
css: 'demo/test1.css',
html: 'demo/html/test1.html',
trim : true,
shorten : true,
verbose : true
},
'myconfig.json'
);
</code></pre>
<br>
<br>
<br>
<br>
<br>
<br>
<h3 id="headerReport">CSS-PURGE Report Viewer</h3>
<br>
<img width="98%" src="assets/images/css_purge_report.jpg" alt="CSS Purge Report Example">
<br>
<br>
<br>
<br>
<img width="70%" src="assets/images/css_purge_report_viewer_ux.jpg" alt="CSS Purge Report Viewer User Experience or Workflow">
<p style="margin-top:5px;">CSS-PURGE Report Viewer is installed separately to nicely present the report data that CSS-PURGE generates.</p>
<br>
<p>Open a separate terminal window, then:</p>
<h6>Clone with <a href="https://git-scm.com" target="_blank">git</a>/<a target="_blank" href="https://desktop.github.com">GitHub Desktop</a>:</h6>
<span class="mdl-list__item-primary-content">
<span class="mdl-chip">
<span class="mdl-chip__text">git clone https://github.com/rbtech/css-purge-report-viewer.git</span>
</span>
</span>
<h6>or download from: <a href="https://github.com/rbtech/css-purge-report-viewer" target="_blank">https://github.com/rbtech/css-purge-report-viewer</a></h6>
<br>
<h6>Install reload:</h6>
<span class="mdl-list__item-primary-content">
<span class="mdl-chip">
<span class="mdl-chip__text">npm install reload -g</span>
</span>
</span>
<br>
<br>
<h6>Run reload to view the report:</h6>
<span class="mdl-list__item-primary-content">
<span class="mdl-chip">
<span class="mdl-chip__text">reload -b -e html, css, js, json</span>
</span>
</span>
<br>
<br>
<div style="width:420px;" class="mdl-card mdl-shadow--2dp">
<div class="mdl-card__supporting-text">
<h2 class="mdl-card__title-text">Report Notes</h2>
<br>
Some things to check:
<ul>
<li>make sure you are in the report viewers directory before running reload</li>
<li>make sure CSS-Purge is set to generate into the report viewers directory</li>
</ul>
</div>
</div>
<br>
<br>
<br>
<br>
<h3 id="headerConfig">Config Options</h3>
<h4>For an overview of some of the options/features,
<br>have a look <a class="underTheHoodLink" href="#features">Under the hood</a>
</h4>
<br>
<br>
Example config.json:
<pre><code class="hljs json">
{
"options": {
"css_output": "purged.min.css",
"css": "demo/html/static-jekyll/_siteassets/main.css",
"html": "demo/html/static-jekyll/_site",
"new_reduce_common_into_parent": false,
"trim": true,
"trim_keep_non_standard_inline_comments": false,
"trim_removed_rules_previous_comment": true,
"trim_comments": false,
"trim_whitespace": false,
"trim_breaklines": false,
"trim_last_semicolon": false,
"shorten": true,
"shorten_zero": false,
"shorten_hexcolor": false,
"shorten_hexcolor_extended_names": false,
"shorten_hexcolor_UPPERCASE": false,
"shorten_font": false,
"shorten_background": true,
"shorten_background_min": 2,
"shorten_margin": false,
"shorten_padding": false,
"shorten_list_style": false,
"shorten_outline": false,
"shorten_border": false,
"shorten_border_top": false,
"shorten_border_right": false,
"shorten_border_bottom": false,
"shorten_border_left": false,
"shorten_border_radius": false,
"format": true,
"format_4095_rules_legacy_limit": false,
"format_font_family": true,
"special_convert_rem": false,
"special_convert_rem_browser_default_px": "16",
"special_convert_rem_desired_html_px": "10",
"special_convert_rem_font_size": true,
"special_reduce_with_html" : false,
"special_reduce_with_html_ignore_selectors" : [
"@-ms-",
":-ms-",
"::",
":valid",
":invalid",
"+.",
":-"
],
"generate_report": true,
"verbose": true,
"bypass_media_rules": true,
"bypass_document_rules": false,
"bypass_supports_rules": false,
"bypass_page_rules": false,
"bypass_charset": false,
"zero_units": "em, ex, %, px, cm, mm, in, pt, pc, ch, rem, vh, vw, vmin, vmax",
"zero_ignore_declaration": [],
"report_file_location": "report/purged_css_report_data.json",
"reduce_declarations_file_location": "config_reduce_declarations.json"
}
}
</code></pre>
<br>
<br>
<table class="table1">
<thead>
<tr>
<th class="mdl-data-table__cell--non-numeric">Option</th>
<th class="mdl-data-table__cell--non-numeric">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
css_output
</td>
<td>
The name of the CSS file to output as.
</td>
</tr>
<tr>
<td>
css
</td>
<td>
CSS file(s) to be processed.
<br>- Can be a comma delimited string or an array of strings.
<br>- Each string represents a local file, folder or web URL.
</td>
</tr>
<tr>
<td>
html
</td>
<td>
HTML file(s) to be searched for CSS that is used.
<br>- Can be a comma delimited string or an array of strings.
<br>- Each string represents a local file, folder or web URL.
</td>
</tr>
<tr>
<td>
trim
</td>
<td>
A “master switch” to turn on all the trim options.
<br>- Only when its off can you turn on or off the other trim options.
</td>
</tr>
<tr>
<td>
trim_keep_non_standard_inline_comments
</td>
<td>
Converts “//” comments into “/* */” comments.
<br> - // comments are removed by default.
</td>
</tr>
<tr>
<td>
trim_removed_rules_previous_comment
</td>
<td>
Removes the comment (if it exists) before the rule that is removed.
</td>
</tr>
<tr>
<td>
trim_comments
</td>
<td>
Removes all comments
</td>
</tr>
<tr>
<td>
trim_whitespace
</td>
<td>
Removes all white/extra space
</td>
</tr>
<tr>
<td>
trim_breaklines
</td>
<td>
Removes all carriage returns / new lines.
</td>
</tr>
<tr>
<td>
trim_last_semicolon
</td>
<td>
Removes the last semicolon of in each rule.
</td>
</tr>
<tr>
<td>
shorten
</td>
<td>
A “master switch” to turn on all the shorten options.
<br>- Only when its off can you turn on or off the other shorten options.
<br>- Exceptions: shorten_hexcolor_UPPERCASE, shorten_background_min
</td>
</tr>
<tr>
<td>
shorten_zero
</td>
<td>
Shortens all zero numbers by:
<br>- removing duplicate leading zeros e.g. 0000px; becomes 0;
<br>- converts units like 0px to 0
</td>
</tr>
<tr>
<td>
shorten_hexcolor
</td>
<td>
Evaluates all named colors and converts them to thier hex color equivalents where shorter. e.g. blue to #00f
<br>- <a href="https://www.w3.org/TR/2011/REC-css3-color-20110607" target="_blank">color list reference</a>
</td>
</tr>
<tr>
<td>
shorten_hexcolor_extended_names
</td>
<td>
Evaluates all named colors in the extended range and converts them to thier hex color equivalents where shorter. e.g. crimson to #dc143c
<br>- <a href="https://www.w3.org/TR/2011/REC-css3-color-20110607" target="_blank">color list reference</a>
</td>
</tr>
<tr>
<td>
shorten_hexcolor_UPPERCASE
</td>
<td>
Converts all hex colors to uppercase e.g. #ae1122 to #AE1122
</td>
</tr>
<tr>
<td>
shorten_font
</td>
<td>
Groups as many font properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/font" target="_blank">shortened version</a>.
</td>
</tr>
<tr>
<td>
shorten_background
</td>
<td>
Groups as many background properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/background" target="_blank">shortened version</a>.
</td>
</tr>
<tr>
<td>
shorten_background_min
</td>
<td>
The minimum amount of properties before it will attempt to group the properties into the shortened version. Default setting is 2.</a>
</td>
</tr>
<tr>
<td>
shorten_margin
</td>
<td>
Groups as many margin properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/margin" target="_blank">shortened versions</a>.
</td>
</tr>
<tr>
<td>
shorten_padding
</td>
<td>
Groups as many padding properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/padding" target="_blank">shortened versions</a>.
</td>
</tr>
<tr>
<td>
shorten_list_style
</td>
<td>
Groups as many list-style properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/list-style" target="_blank">shortened version</a>.
</td>
</tr>
<tr>
<td>
shorten_outline
</td>
<td>
Groups as many outline properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/outline" target="_blank">shortened version</a>.
</td>
</tr>
<tr>
<td>
shorten_border
</td>
<td>
Groups as many border properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/border" target="_blank">shortened version</a>.
</td>
</tr>
<tr>
<td>
shorten_border_top
</td>
<td>
Groups as many border-top properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/border-top" target="_blank">shortened version</a>.
</td>
</tr>
<tr>
<td>
shorten_border_right
</td>
<td>
Groups as many border-right properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/border-right" target="_blank">shortened version</a>.
</td>
</tr>
<tr>
<td>
shorten_border_bottom
</td>
<td>
Groups as many border-bottom properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/border-bottom" target="_blank">shortened version</a>.
</td>
</tr>
<tr>
<td>
shorten_border_left
</td>
<td>
Groups as many border-left properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/border-left" target="_blank">shortened version</a>.
</td>
</tr>
<tr>
<td>
shorten_border_radius
</td>
<td>
Groups as many border-radius properties into the <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius" target="_blank">shortened versions</a>.
</td>
</tr>
<tr>
<td>
format
</td>
<td>
A “master switch” to turn on all the shorten options.
<br>- Only when its off can you turn on or off the other shorten options.
<br>- Exceptions: format_4095_rules_legacy_limit
</td>
</tr>
<tr>
<td>
format_4095_rules_legacy_limit
</td>
<td>
Some legacy browsers, like <a href="https://blogs.msdn.microsoft.com/ieinternals/2011/05/14/stylesheet-limits-in-internet-explorer" target="_blank">Internet Explorer 6-9</a>, only support upto 4095 rules per stylesheet.
<br>This feature helps bypass that limit by splitting the output CSS file into several CSS files. Filling from first to last.
</td>
</tr>
<tr>
<td>
format_font_family
</td>
<td>
Adds double quotes to multi-worded fonts if they are missing.
</td>
</tr>
<tr>
<td>
special_convert_rem
</td>
<td>
A “master switch” to turn on all the special convert to rem options.
</td>
</tr>
<tr>
<td>
special_convert_rem_browser_default_px
</td>
<td>
The default browser font size you are catering for.
</td>
</tr>
<tr>
<td>
special_convert_rem_desired_html_px
</td>
<td>
The default browser font size that you want.
</td>