forked from WebArtWork/wjst-default
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
2115 lines (2061 loc) · 67.4 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>
<head>
<base href="/" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Welcome to waw Template</title>
<meta itemprop="name" content="Welcome to waw Template" />
<meta name="twitter:title" content="Welcome to waw Template" />
<meta property="og:title" content="Welcome to waw Template" />
<meta name="description" content="Description which will fit on all pages" />
<meta itemprop="description" content="Description which will fit on all pages" />
<meta name="twitter:description" content="Description which will fit on all pages" />
<meta property="og:description" content="Description which will fit on all pages" />
<meta itemprop="image" content="https://webartwork.github.io/wjst-default/img/avatar.png" />
<meta name="twitter:image:src" content="https://webartwork.github.io/wjst-default/img/avatar.png" />
<meta property="og:image" content="https://webartwork.github.io/wjst-default/img/avatar.png" />
<link rel="icon" type="image/x-icon" href="img/favicon.ico" />
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<link rel="stylesheet" href="css/index.css" />
</head>
<body>
<header class="header">
<span class="header__left">
<a href="/" class="header__logo-link">
<img src="img/logo.svg" alt="WAW" width="45" class="header__logo" />
</a>
<h1 class="header__title">Wjst</h1>
</span>
<span class="header__right">
<ul class="header__nav">
<li class="header__nav-item">
<a href="/documentations" class="header__nav-link">Documentations</a>
</li>
</ul>
<ul class="header__nav">
<li class="header__nav-item">
<a href="https://github.com/WebArtWork/wjst" target="_blank" data-original-title="GitHub"
class="header__nav-link header__nav-link--github">
<img src="img/github.svg" alt="github" class="header__nav-icon">
</a>
</li>
</ul>
<span class="header__nav header__nav--mobile material-icons"
onclick="toggleClass('sidebar', 'main-content__nav--show')">menu</span>
</span>
</header>
<main class="main-content">
<nav id="sidebar" class="main-content__nav">
<ul>
<li class="main-content__nav-item main-content__nav-item--mobile">
<a href="/documentations" class="header__nav-link">Documentations</a>
</li>
<li class="main-content__nav-item">
<a href="/documentations2" class="main-content__nav-link">Getting started</a>
</li>
<li class="main-content__nav-item">
<a href="/documentations2" class="main-content__nav-link">Customize</a>
<ul class="main-content__nav-in">
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Sass</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">CSS Variables</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Template Variables</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Optimize</a>
</li>
</ul>
</li>
<li class="main-content__nav-item">
<a href="/documentations2" class="main-content__nav-link">Layout</a>
<ul class="main-content__nav-in">
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Breakpoints</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Containers</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Grid</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Columns</a>
</li>
</ul>
</li>
<li class="main-content__nav-item">
<a href="/documentations2" class="main-content__nav-link">Content</a>
<ul class="main-content__nav-in">
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Typography</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Images</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Tables</a>
</li>
</ul>
</li>
<li class="main-content__nav-item">
<a href="/documentations2" class="main-content__nav-link">Components</a>
<ul class="main-content__nav-in">
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Alerts</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Breadcrumb</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Buttons</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Collapse</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Dropdowns</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Modal</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Navbar</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Pagination</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Popovers</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Progress</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Spinners</a>
</li>
</ul>
</li>
<li class="main-content__nav-item">
<a href="/documentations2" class="main-content__nav-link">About</a>
<ul class="main-content__nav-in">
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Team</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">Brand</a>
</li>
<li class="main-content__nav-in-item">
<a href="/#typography" class="main-content__nav-link">License</a>
</li>
</ul>
</li>
<!-- should be shown on mobile and web with sub ul -->
<li class="main-content__nav-item main-content__nav-item--active">
<a href="/documentations2" class="main-content__nav-link">Should be shown highlighted</a>
<ul class="main-content__nav-in">
<li class="main-content__nav-in-item">
<a href="/documentations21" class="main-content__nav-link">Documentations 2 1</a>
</li>
<li class="main-content__nav-in-item">
<a href="/documentations22" class="main-content__nav-link">Documentations 2 2</a>
</li>
</ul>
</li>
<!-- should be shown on mobile and web without sub ul -->
<li class="main-content__nav-item">
<a href="/documentations2" class="main-content__nav-link">Should be shown</a>
<ul class="main-content__nav-in--none">
<li class="main-content__nav-in-item">
<a href="/documentations21" class="main-content__nav-link">Should not be shown</a>
</li>
</ul>
</li>
</ul>
</nav>
<section class="main-content__section">
<div class="index">
<img class="index-avatar" src="img/avatar.png" alt="" />
<!-- <div class="index-readme__item">
To create new page you can type in terminal:
<span class="index-readme__code">waw page NAME</span>
</div>
<div class="index-readme__item">
You can change port in
<span class="index-readme__code">config.json</span>
of development webiste
<a class="index-readme__link" href="http://localhost:8000">localhost:8000</a>
</div>
<div class="index-readme__item">
JSON in template.json is accesible over all pages
</div>
<div class="index-readme__item">
JSON in page.json of each page is accesible only of that specific
page
</div>
<div class="index-readme__item">
To build project you can type in terminal:
<span class="index-readme__code">waw build</span>
which will take JSON info and put it into html of dist folder.
</div>
<div class="index-readme__item">
General idea of variables, is that you can modify those on back-end or over
<span class="index-readme__code">config.json</span>
</div>
<div class="index-readme__item">
More details of how to use template you can find in
<a class="index-readme__link" href="https://webartwork.github.io/wjst/docs">Wjst Documentation</a>
</div>
<div class="index-readme__item">
Styles: You should import each file to
<span class="index-readme__code">index.scss </span> located in
<span class="index-readme__code">css</span> folder and write SCSS
files in <span class="index-readme__code">css/scss</span>.
</div>
</div>
<div class="index-readme">
<div class="index-readme__title">Prefix:</div>
<div class="index-readme__item">
Prefix which we have in template.json serve as root id for the
template
</div>
<div class="index-readme__item">
For example file
<span class="index-readme__code">img/avatar.png</span>
can be served in html
<span class="index-readme__code">src="img/avatar.png"</span>
were our path is
<span class="index-readme__code">{prefix}{path}</span>
</div>
<div class="index-readme__item">
Prefix should be unique on project where we have more then one
template to serve files properly
</div>
<div class="index-readme__item">
To change prefix, you need simply to replace all in editor phrase
`/wjst-default` into new prefix `/newPrefixName`
</div>
<div class="index-readme__item">
To get served template by github pages, you simply have to replace
prefix to name of the repo and do
<span class="index-readme__code">waw build</span>
and then commit to branch which you set in settings > pages
<span class="index-readme__code">{repo}/settings/pages</span>
and after that you should able to see your wesite online, similar
this default repo is shown
<a class="index-readme__link"
href="https://webartwork.github.io/wjst-default">webartwork.github.io/wjst-default</a>
</div> -->
<div class="index-title">Welcome to WAW Template</div>
<div class="index-readme">
<div id="typography">
<div class="index-readme__title">
<h1>Typography</h1>
<p>
Documentation and examples for waw framework typography, including global settings, headings,
body
text,
lists, and more.
</p>
</div>
</div>
<div id="global-settings">
<div class="index-readme__title"><a id="typography">
<h3>Global settings</h3>
</a></div>
<p>waw css sets basic global display, typography, and link styles. When more control is needed, check
out
the
<span class="index-readme__code">
<a class="index-readme__link">textual utility
classes.</a>
</span>
</p>
<ul class="list-style">
<li>Use a <span class="index-readme__code">native font stack</span> that selects the best <span
class="index-readme__code">font-family</span>
for each OS and device.</li>
<li>For a more inclusive and accessible type scale, we use the browser’s default root <span
class="index-readme__code">font-size</span> (typically 16px) so visitors can customize their
browser defaults as needed.
</li>
<li>Use the <span class="index-readme__code">$font-family-base</span>, <span
class="index-readme__code">$font-size-base</span>, and <span
class="index-readme__code">$line-height-base</span> attributes as our typographic base
applied
to the <span class="index-readme__code"><body></span>.
</li>
<li>Set the global link color via <span class="index-readme__code">$link-color</span>.</li>
<li>Use <span class="index-readme__code">$body-bg</span> to set a <span
class="index-readme__code">background-color</span> on the <span
class="index-readme__code"><body></span> (<span class="index-readme__code">#fff</span>
by
default).</li>
</ul>
<p>These styles can be found within <span class="index-readme__code">_reboot.scss</span>, and the global
variables are defined in <span class="index-readme__code">_variables.scss</span>. Make sure to set
<span class="index-readme__code">$font-size-base</span> in <span class="index-readme__code">rem</span>.
</p>
</div>
<div id="headings">
<div class="index-readme__title">
<h3>Headings</h3>
</div>
<p>All HTML headings,
<span class="index-readme__code"><h1></span> through <span
class="index-readme__code"><h6></span>, are available.
</p>
<div class="example-tables">
<table class="table">
<thead>
<tr>
<th>Heading</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="index-readme__code"><h1></h1></span></td>
<td><span class="h1">h1. waw heading</span></td>
</tr>
<tr>
<td><span class="index-readme__code"><h2></h2></span></td>
<td><span class="h2">h2. waw heading</span></td>
</tr>
<tr>
<td><span class="index-readme__code"><h3></h3></span></td>
<td><span class="h3">h3. waw heading</span></td>
</tr>
<tr>
<td><span class="index-readme__code"><h4></h4></span></td>
<td><span class="h4">h4. waw heading</span></td>
</tr>
<tr>
<td><span class="index-readme__code"><h5></h5></span></td>
<td><span class="h5">h5. waw heading</span></td>
</tr>
<tr>
<td><span class="index-readme__code"><h6></h6></span></td>
<td><span class="h6">h6. waw heading</span></td>
</tr>
</tbody>
</table>
</div>
<div class="index-readme__item">
<ul>
<li><<span class="index-readme__code">h1</span>>h1. waw heading</<span
class="index-readme__code">h1</span>></li>
<li><<span class="index-readme__code">h2</span>>h2. waw heading</<span
class="index-readme__code">h2</span>></li>
<li><<span class="index-readme__code">h3</span>>h3. waw heading</<span
class="index-readme__code">h3</span>></li>
<li><<span class="index-readme__code">h4</span>>h4. waw heading</<span
class="index-readme__code">h4</span>></li>
<li><<span class="index-readme__code">h5</span>>h5. waw heading</<span
class="index-readme__code">h5</span>></li>
<li><<span class="index-readme__code">h6</span>>h6. waw heading</<span
class="index-readme__code">h6</span>></li>
</ul>
</div>
<p><span class="index-readme__code">.h1</span> through <span class="index-readme__code">.h6</span>
classes
are also available, for when you want to match the font styling of a heading but cannot use the
associated HTML element.</p>
<div class="example">
<ul>
<li>
<td><span class="h1">h1. waw heading</span></td>
</li>
<li>
<td><span class="h2">h2. waw heading</span></td>
</li>
<li>
<td><span class="h3">h3. waw heading</span></td>
</li>
<li>
<td><span class="h4">h4. waw heading</span></td>
</li>
<li>
<td><span class="h5">h5. waw heading</span></td>
</li>
<li>
<td><span class="h6">h6. waw heading</span></td>
</li>
</ul>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><p class="h1">h1. waw heading</p></li>
<li><p class="h2">h2. waw heading</p></li>
<li><p class="h3">h3. waw heading</p></li>
<li><p class="h4">h4. waw heading</p></li>
<li><p class="h5">h5. waw heading</p></li>
<li><p class="h6">h6. waw heading</p></li>
</ul>
</div>
</div>
<div id="customizing-headings">
<div class="index-readme__title">
<h3>Customizing headings</h3>
</div>
<p>Use the included utility classes to recreate the small secondary heading text.
</p>
<div class="example">
<h3>Fancy display heading <small class="text-body-secondary">With faded secondary text</small>
</h3>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><h3></li>
<li>Fancy display heading</li>
<li><small class="text-body-secondary">With faded secondary text</small></li>
<li></h3></li>
</ul>
</div>
</div>
<div id="display-headings">
<div class="index-readme__title">
<h3>Display headings</h3>
</div>
<p>Traditional heading elements are designed to work best in the meat of your page content. When you
need a
heading to stand out, consider using a <strong>display heading</strong> — a larger, slightly more
opinionated heading style.
</p>
<div class="example">
<h1 class="display-1">Display 1</h1>
<h1 class="display-2">Display 2</h1>
<h1 class="display-3">Display 3</h1>
<h1 class="display-4">Display 4</h1>
<h1 class="display-5">Display 5</h1>
<h1 class="display-6">Display 6</h1>
</div>
<div class="index-readme__item">
<ul>
<li><h1 class="display-1">Display 1<h1></li>
<li><h1 class="display-2">Display 2<h1></li>
<li><h1 class="display-3">Display 3<h1></li>
<li><h1 class="display-4">Display 4<h1></li>
<li><h1 class="display-5">Display 5<h1></li>
<li><h1 class="display-6">Display 6<h1></li>
</ul>
</div>
<p>
Display headings are configured via the <span class="index-readme__code">$display-font-sizes</span>
Sass
map
and two variables, <span class="index-readme__code">$display-font-weight</span>
and <span class="index-readme__code">$display-line-height</span>.
</p>
<p>
Display headings are customizable via two variables, <span
class="index-readme__code">$display-font-family</span> and <span
class="index-readme__code">$display-font-style</span>.
</p>
<!-- need to change and to paste some icons -->
<p>scss/_variables.scss:</p>
<div class="index-readme__item">
<ul>
<li>$display-font-sizes: (</li>
<li>1: 5rem,</li>
<li>2: 4.5rem,</li>
<li>3: 4rem,</li>
<li>4: 3.5rem,</li>
<li>5: 3rem,</li>
<li>6: 2.5rem</li>
<li>);</li>
<li><br></li>
<li>$display-font-family: null;</li>
<li>$display-font-style: null;</li>
<li>$display-font-weight: 300;</li>
<li>$display-line-height: $headings-line-height;</li>
</ul>
</div>
</div>
<div id="lead">
<div class="index-readme__title">
<h3>Lead</h3>
</div>
<p>Make a paragraph stand out by adding <span class="index-readme__code">.lead</span>.
</p>
<div class="example">
<p class="lead">
This is a lead paragraph. It stands out from regular paragraphs.
</p>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><p class="lead"></li>
<li> This is a lead paragraph. It stands out from regular paragraphs.</li>
<li></p></li>
</ul>
</div>
</div>
<div id="inline-text-elements">
<div class="index-readme__title">
<h3>Inline text elements</h3>
</div>
<p>Styling for common inline HTML5 elements.</p>
<div class="example">
<p>You can use the mark tag to <mark>highlight</mark> text.</p>
<p><del>This line of text is meant to be treated as deleted text.</del></p>
<p><s>This line of text is meant to be treated as no longer accurate.</s></p>
<p><ins>This line of text is meant to be treated as an addition to the document.</ins></p>
<p><u>This line of text will render as underlined.</u></p>
<p><small>This line of text is meant to be treated as fine print.</small></p>
<p><strong>This line rendered as bold text.</strong></p>
<p><em>This line rendered as italicized text.</em></p>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><p>You can use the mark tag to <mark>highlight</mark> text.</p></li>
<li><p><del>This line of text is meant to be treated as deleted
text.</del></p>
</li>
<li><p><s>This line of text is meant to be treated as no longer
accurate.</s></p></li>
<li><p><ins>This line of text is meant to be treated as an addition to the
document.</ins></p></li>
<li><p><u>This line of text will render as underlined.</u></p></li>
<li><p><small>This line of text is meant to be treated as fine
print.</small></p></li>
<li><p><strong>This line rendered as bold text.</strong></p></li>
<li><p><em>This line rendered as italicized text.</em></p></li>
</ul>
</div>
<p>
Beware that those tags should be used for semantic purpose:
</p>
<ul class="list-style">
<li><span class="index-readme__code"><mark></span> represents text which is marked or
highlighted
for
reference or notation purposes.</li>
<li><span class="index-readme__code"><small></span> represents side-comments and small print,
like
copyright and legal text.
</li>
<li><span class="index-readme__code"><s></span> represents element that are no longer relevant
or
no
longer accurate.</li>
<li><span class="index-readme__code"><u></span> represents a span of inline text which should
be
rendered in a way that indicates that it has a non-textual annotation.</li>
</ul>
<p>
If you want to style your text, you should use the following classes instead:
</p>
<ul class="list-style">
<li><span class="index-readme__code">.mark</span> will apply the same styles as <span
class="index-readme__code"><mark></span></li>
<li><span class="index-readme__code">.small</span> will apply the same styles as <span
class="index-readme__code"><small></span></li>
<li><span class="index-readme__code">.text-decoration-underline</span> will apply the same styles as
<span class="index-readme__code"><s></span>
</li>
<li><span class="index-readme__code">.text-decoration-line-through</span> will apply the same styles
as
<span class="index-readme__code"><u></span>
</li>
</ul>
<p>
While not shown above, feel free to use <span class="index-readme__code"><b></span> and <span
class="index-readme__code"><i></span> in HTML5. <span
class="index-readme__code"><b></span>
is meant to highlight words or phrases without conveying additional importance, while <span
class="index-readme__code"><i></span> is mostly for voice, technical terms, etc.
</p>
</div>
<div id="text-utilities">
<div class="index-readme__title">
<h3>Text utilities</h3>
</div>
<p>Change text alignment, transform, style, weight, line-height, decoration and color with our <span
class="index-readme__code">
<a class="index-readme__link">text utilities</a>
</span> and <span class="index-readme__code">
<a class="index-readme__link">color utilities</a>
</span>.</p>
</div>
<div id="abbreviations">
<div class="index-readme__title">
<h3>Abbreviations</h3>
</div>
<p>
Stylized implementation of HTML’s <span class="index-readme__code"><abbr></span> element for
abbreviations and acronyms to show the expanded version on hover. Abbreviations have a default
underline
and
gain a help cursor to provide additional context on hover and to users of assistive technologies.
</p>
<p>
Add <span class="index-readme__code">.initialism</span> to an abbreviation for a slightly smaller
font-size.
</p>
<div class="example">
<p><abbr title="attribute">attr</abbr></p>
<p><abbr title="HyperText Markup Language" class="initialism">HTML</abbr></p>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><p> <abbr title="attribute">attr</abbr></p></li>
<li><p> <abbr title="HyperText Markup Language" class="initialism">HTML</abbr></p>
</li>
</ul>
</div>
</div>
<div id="blockquotes">
<div class="index-readme__title">
<h3>Blockquotes</h3>
</div>
<p>For quoting blocks of content from another source within your document. Wrap <span
class="index-readme__code"><blockquote class="blockquote"></span> around any HTML as the
quote.
</p>
<div class="example">
<blockquote class="blockquote">
<p>A well-known quote, contained in a blockquote element.</p>
</blockquote>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><blockquote class="blockquote"></li>
<li><p>A well-known quote, contained in a blockquote element.</p></li>
<li></blockquote></li>
</ul>
</div>
</div>
<div id="naming-a-source">
<div class="index-readme__title">
<h3>Naming a source</h3>
</div>
<p>The HTML spec requires that blockquote attribution be placed outside the
<span class="index-readme__code"><blockquote></span>. When providing attribution, wrap your <span
class="index-readme__code"><blockquote></span> in a <span
class="index-readme__code"><figure></span> and use a
<span class="index-readme__code"><figcaption></span> or a block
level element (e.g., <span class="index-readme__code"><p></span>) with the <span
class="index-readme__code">.blockquote-footer</span> class. Be sure to wrap the name of the
source work in <span class="index-readme__code"><cite></span> as well.
</p>
<div class="example">
<figure>
<blockquote class="blockquote">
<p>A well-known quote, contained in a blockquote element.</p>
</blockquote>
<figcaption class="blockquote-footer">
- Someone famous in <cite title="Source Title">Source Title</cite>
</figcaption>
</figure>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><figure></li>
<li><blockquote class="blockquote"></li>
<li><p>A well-known quote, contained in a blockquote element.</p></li>
<li></blockquote></li>
<li><figcaption class="blockquote-footer"></li>
<li>Someone famous in <cite title="Source Title">Source Title</cite></li>
<li></figcaption></li>
<li></figure></li>
</ul>
</div>
</div>
<div id="alignment">
<div class="index-readme__title">
<h3>Alignment</h3>
</div>
<p>
Use text utilities as needed to change the alignment of your blockquote.
</p>
<div class="example">
<figure class="text-center">
<blockquote class="blockquote">
<p>A well-known quote, contained in a blockquote element.</p>
</blockquote>
<figcaption class="blockquote-footer">
- Someone famous in <cite title="Source Title">Source Title</cite>
</figcaption>
</figure>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><figure class="text-center"></li>
<li><blockquote class="blockquote"></li>
<li><p>A well-known quote, contained in a blockquote element.</p></li>
<li></blockquote></li>
<li><figcaption class="blockquote-footer"></li>
<li>Someone famous in <cite title="Source Title">Source Title</cite></li>
<li></figcaption></li>
<li></figure></li>
</ul>
</div>
<div class="example">
<figure class="text-end">
<blockquote class="blockquote">
<p>A well-known quote, contained in a blockquote element.</p>
</blockquote>
<figcaption class="blockquote-footer">
- Someone famous in <cite title="Source Title">Source Title</cite>
</figcaption>
</figure>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><figure class="text-end"></li>
<li><blockquote class="blockquote"></li>
<li><p>A well-known quote, contained in a blockquote element.</p></li>
<li></blockquote></li>
<li><figcaption class="blockquote-footer"></li>
<li>Someone famous in <cite title="Source Title">Source Title</cite></li>
<li></figcaption></li>
<li></figure></li>
</ul>
</div>
</div>
<div id="unstyled">
<div class="index-readme__title">
<h3>Lists</h3>
<h3>Unstyled</h3>
</div>
<p>Remove the default <span class="index-readme__code">list-style</span> and left margin on list items
(immediate children only). <strong>This only applies to immediate children list items</strong>,
meaning
you
will need to add the class for any nested lists as well.</p>
<div class="example">
<ul>
<li>This is a list.</li>
<li>It appears completely unstyled.</li>
<li>Structurally, it's still a list.</li>
<li>However, this style only applies to immediate child elements.</li>
<li>Nested lists:</li>
<ul class="list-style">
<li>are unaffected by this style</li>
<li>will still show a bullet</li>
<li>and have appropriate left margin</li>
</ul>
<li>This may still come in handy in some situations.</li>
</ul>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><ul class="list-unstyled"></li>
<li><li>This is a list.</li></li>
<li><li>It appears completely unstyled.</li></li>
<li><li>Structurally, it's still a list.</li></li>
<li><li>However, this style only applies to immediate child elements.</li></li>
<li><li>Nested lists:</li>
<li><ul></li>
<li><li>are unaffected by this style</li></li>
<li><li>will still show a bullet</li></li>
<li><li>and have appropriate left margin</li></li>
<li></ul></li>
<li></li></li>
<li><li>This may still come in handy in some situations.</li></li>
<li></ul></li>
</ul>
</div>
</div>
<div id="inline">
<div class="index-readme__title">
<h3>Inline</h3>
</div>
<p>Remove a list’s bullets and apply some light <span class="index-readme__code">margin</span> with a
combination of two classes, <span class="index-readme__code">.list-inline</span> and <span
class="index-readme__code">.list-inline-item</span>.</p>
<div class="example">
<ul class="list-inline">
<li class="list-inline-item">This is a list item.</li>
<li class="list-inline-item">And another one.</li>
<li class="list-inline-item">But they're displayed inline.</li>
</ul>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><ul class="list-inline"></li>
<li><li class="list-inline-item">This is a list item.</li></li>
<li><li class="list-inline-item">And another one.</li></li>
<li><li class="list-inline-item">But they're displayed inline.</li></li>
<li></ul></li>
</ul>
</div>
</div>
<!-- need to write scss -->
<div id="description-list-alignment">
<div class="index-readme__title">
<h3>Description list alignment</h3>
</div>
<p>Align terms and descriptions horizontally by using our grid system’s predefined classes (or semantic
mixins). For longer terms, you can optionally add a <span
class="index-readme__code">.text-truncate</span> class to truncate the text with an ellipsis.
</p>
<div class="example">
<dl class="row">
<dt class="col-sm-3">Description lists</dt>
<dd class="col-sm-9">A description list is perfect for defining terms.</dd>
<dt class="col-sm-3">Term</dt>
<dd class="col-sm-9">
<p>Definition for the term.</p>
<p>And some more placeholder definition text.</p>
</dd>
<dt class="col-sm-3">Another term</dt>
<dd class="col-sm-9">This definition is short, so no extra paragraphs or anything.</dd>
<dt class="col-sm-3 text-truncate">Truncated term is truncated</dt>
<dd class="col-sm-9">This can be useful when space is tight. Adds an ellipsis at the end.</dd>
<dt class="col-sm-3">Nesting</dt>
<dd class="col-sm-9">
<dl class="row">
<dt class="col-sm-4">Nested definition list</dt>
<dd class="col-sm-8">I heard you like definition lists. Let me put a definition list
inside
your definition list.</dd>
</dl>
</dd>
</dl>
</div>
<!-- need to paste some icons -->
<div class="index__html">
<p>
HTML:
</p>
</div>
<div class="index-readme__item">
<ul>
<li><dl class="row"></li>
<li><dt class="col-sm-3">Description lists</dt></li>
<li><dd class="col-sm-9">A description list is perfect for defining terms.</dd></li><br>
<li><dt class="col-sm-3">Term</dt></li>
<li><dd class="col-sm-9"></li>
<li><p>Definition for the term.</p></li>
<li><p>And some more placeholder definition text.</p></li>
<li></dd></li><br>
<li><dt class="col-sm-3">Another term</dt></li>
<li><dd class="col-sm-9">This definition is short, so no extra paragraphs or
anything.</dd>
</li><br>
<li><dt class="col-sm-3 text-truncate">Truncated term is truncated</dt></li>
<li><dd class="col-sm-9">This can be useful when space is tight. Adds an ellipsis at the
end.</dd></li><br>
<li><dt class="col-sm-3">Nesting</dt></li>
<li><dd class="col-sm-9"></li>
<li><dl class="row"></li>
<li><dt class="col-sm-4">Nested definition list</dt></li>
<li><dd class="col-sm-8">I heard you like definition lists. Let me put a definition list
inside
your definition list.</dd></li>
<li></dl></li>
<li></dd></li>
<li></dl></li>
</ul>
</div>
</div>
<div id="responsive-font-sizes">
<div class="index-readme__title">
<h3>Responsive font sizes</h3>
</div>
<p>In Bootstrap 5, we’ve enabled responsive font sizes by default, allowing text to scale more naturally
across device and viewport sizes. Have a look at the <span class="index-readme__code">RFS
page</span> to
find out how this works.</p>
</div>
<div id="tupography-css">
<div class="index-readme__title">
<h3>CSS</h3>
<h3>Sass variables</h3>
</div>
<p>Headings have some dedicated variables for sizing and spacing.</p>
<p>scss/_variables.scss:</p>
<div class="index-readme__item">
<ul>
<li>$headings-margin-bottom: $spacer * .5;</li>
<li>$headings-font-family: null;</li>
<li>$headings-font-style: null;</li>
<li>$headings-font-weight: 500;</li>
<li>$headings-line-height: 1.2;</li>
<li>$headings-color: inherit;</li>
</ul>
</div>
<p>Miscellaneous typography elements covered here and in <span class="index-readme__code">Reboot</span>
also
have dedicated variables.
</p>
<p>scss/_variables.scss:</p>
<div class="index-readme__item">
<ul>
<li>$lead-font-size: $font-size-base * 1.25;</li>
<li>$lead-font-weight: 300;</li><br>
<li>$small-font-size: .875em;</li><br>
<li>$sub-sup-font-size: .75em;</li><br>
<li>// fusv-disable</li>
<li>$text-muted: var(--#{$prefix}secondary-color); // Deprecated in 5.3.0</li>
<li>// fusv-enable</li><br>
<li>$initialism-font-size: $small-font-size;</li><br>
<li>$blockquote-margin-y: $spacer;</li>
<li>$blockquote-font-size: $font-size-base * 1.25;</li>
<li>$blockquote-footer-color: $gray-600;</li>