Repository navigation
Expand file tree
/
Copy pathindex.html
More file actions
1330 lines (1206 loc) · 86.6 KB
/
Copy pathindex.html
File metadata and controls
1330 lines (1206 loc) · 86.6 KB
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 data-dark-mode="false" data-code-theme="light">
<head>
<script src="/devdocs/markbind/js/theme-manager.js"></script>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="MarkBind 7.1.1">
<meta name="viewport" content="width=device-width, initial-scale=1"><title>CustardUI - Your docs, shaped for every reader</title> <link rel="stylesheet" href="/devdocs/markbind/css/bootstrap.min.css"> <link rel="stylesheet" href="/devdocs/markbind/fontawesome/css/all.min.css">
<link rel="stylesheet" id="markbind-highlight-light" href="/devdocs/markbind/css/codeblock-light.min.css">
<link rel="stylesheet" id="markbind-highlight-dark" href="/devdocs/markbind/css/codeblock-dark.min.css">
<script src="/devdocs/markbind/js/code-theme.js"></script><link rel="stylesheet" href="/devdocs/markbind/css/markbind.min.css"><link rel="stylesheet" href="/devdocs/plugins/codeBlockCopyButtons/codeBlockButtons.css"><link rel="stylesheet" href="/devdocs/plugins/codeBlockWrapButtons/codeBlockButtons.css"><link rel="stylesheet" href="/devdocs/plugins/markbind-plugin-anchors/markbind-plugin-anchors.css"><link rel="stylesheet" href="/devdocs/plugins/markbind-plugin-tree/markbind-plugin-tree.css">
<link rel="stylesheet" href="/devdocs/stylesheets/main.css">
<link rel="stylesheet" href="/devdocs/stylesheets/custard.css">
<link rel="icon" href="/devdocs/favicon.ico"></head>
<script>
const baseUrl = '/devdocs'
</script>
<body
data-code-theme="light">
<div id="app"><!--[--><div tags="dev-release" class="w-100 p-1 bg-info text-center d-print-none"><span><strong>This site documents developmental features of CustardUI (head of develop branch) and possible breaking changes.
For the latest stable release, visit <a href="https://custardui.github.io">here</a>.</strong></span></div> <header sticky><div data-v-94b60ff6><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-94b60ff6><div class="container-fluid" data-v-94b60ff6><div class="navbar-left" data-v-94b60ff6><!--[--><a href="/devdocs/index.html" title="Home" class="navbar-brand"><img src="/devdocs/images/custardUI-words.png" height="40"></a><!--]--></div><div class="navbar-default" data-v-94b60ff6><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-94b60ff6><!--[--> <li><a highlight-on="exact" href="/devdocs/index.html" class="nav-link">HOME</a></li> <li><a highlight-on="sibling-or-child" href="/devdocs/authorGuide/index.html" class="nav-link">AUTHOR GUIDE</a></li> <li><a highlight-on="sibling-or-child" href="/devdocs/devGuide/index.html" class="nav-link">DEVELOPER GUIDE</a></li> <li><a highlight-on="exact" href="/devdocs/about.html" class="nav-link">ABOUT</a></li> <li><a highlight-on="none" href="#cv-open" class="nav-link"><div><div><svg fill="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" width="1.2em" height="1.2em" style="vertical-align:middle;"><path fill-rule="evenodd" clip-rule="evenodd" d="M12 8.00002C9.79085 8.00002 7.99999 9.79088 7.99999 12C7.99999 14.2092 9.79085 16 12 16C14.2091 16 16 14.2092 16 12C16 9.79088 14.2091 8.00002 12 8.00002ZM9.99999 12C9.99999 10.8955 10.8954 10 12 10C13.1046 10 14 10.8955 14 12C14 13.1046 13.1046 14 12 14C10.8954 14 9.99999 13.1046 9.99999 12Z" fill="currentColor"></path> <path fill-rule="evenodd" clip-rule="evenodd" d="M10.7673 1.01709C10.9925 0.999829 11.2454 0.99993 11.4516 1.00001L12.5484 1.00001C12.7546 0.99993 13.0075 0.999829 13.2327 1.01709C13.4989 1.03749 13.8678 1.08936 14.2634 1.26937C14.7635 1.49689 15.1915 1.85736 15.5007 2.31147C15.7454 2.67075 15.8592 3.0255 15.9246 3.2843C15.9799 3.50334 16.0228 3.75249 16.0577 3.9557L16.1993 4.77635L16.2021 4.77788C16.2369 4.79712 16.2715 4.81659 16.306 4.8363L16.3086 4.83774L17.2455 4.49865C17.4356 4.42978 17.6693 4.34509 17.8835 4.28543C18.1371 4.2148 18.4954 4.13889 18.9216 4.17026C19.4614 4.20998 19.9803 4.39497 20.4235 4.70563C20.7734 4.95095 21.0029 5.23636 21.1546 5.4515C21.2829 5.63326 21.4103 5.84671 21.514 6.02029L22.0158 6.86003C22.1256 7.04345 22.2594 7.26713 22.3627 7.47527C22.4843 7.7203 22.6328 8.07474 22.6777 8.52067C22.7341 9.08222 22.6311 9.64831 22.3803 10.1539C22.1811 10.5554 21.9171 10.8347 21.7169 11.0212C21.5469 11.1795 21.3428 11.3417 21.1755 11.4746L20.5 12L21.1755 12.5254C21.3428 12.6584 21.5469 12.8205 21.7169 12.9789C21.9171 13.1653 22.1811 13.4446 22.3802 13.8461C22.631 14.3517 22.7341 14.9178 22.6776 15.4794C22.6328 15.9253 22.4842 16.2797 22.3626 16.5248C22.2593 16.7329 22.1255 16.9566 22.0158 17.14L21.5138 17.9799C21.4102 18.1535 21.2828 18.3668 21.1546 18.5485C21.0028 18.7637 20.7734 19.0491 20.4234 19.2944C19.9803 19.6051 19.4613 19.7901 18.9216 19.8298C18.4954 19.8612 18.1371 19.7852 17.8835 19.7146C17.6692 19.6549 17.4355 19.5703 17.2454 19.5014L16.3085 19.1623L16.306 19.1638C16.2715 19.1835 16.2369 19.2029 16.2021 19.2222L16.1993 19.2237L16.0577 20.0443C16.0228 20.2475 15.9799 20.4967 15.9246 20.7157C15.8592 20.9745 15.7454 21.3293 15.5007 21.6886C15.1915 22.1427 14.7635 22.5032 14.2634 22.7307C13.8678 22.9107 13.4989 22.9626 13.2327 22.983C13.0074 23.0002 12.7546 23.0001 12.5484 23H11.4516C11.2454 23.0001 10.9925 23.0002 10.7673 22.983C10.5011 22.9626 10.1322 22.9107 9.73655 22.7307C9.23648 22.5032 8.80849 22.1427 8.49926 21.6886C8.25461 21.3293 8.14077 20.9745 8.07542 20.7157C8.02011 20.4967 7.97723 20.2475 7.94225 20.0443L7.80068 19.2237L7.79791 19.2222C7.7631 19.2029 7.72845 19.1835 7.69396 19.1637L7.69142 19.1623L6.75458 19.5014C6.5645 19.5702 6.33078 19.6549 6.11651 19.7146C5.86288 19.7852 5.50463 19.8611 5.07841 19.8298C4.53866 19.7901 4.01971 19.6051 3.57654 19.2944C3.2266 19.0491 2.99714 18.7637 2.84539 18.5485C2.71718 18.3668 2.58974 18.1534 2.4861 17.9798L1.98418 17.14C1.87447 16.9566 1.74067 16.7329 1.63737 16.5248C1.51575 16.2797 1.36719 15.9253 1.32235 15.4794C1.26588 14.9178 1.36897 14.3517 1.61976 13.8461C1.81892 13.4446 2.08289 13.1653 2.28308 12.9789C2.45312 12.8205 2.65717 12.6584 2.82449 12.5254L3.47844 12.0054V11.9947L2.82445 11.4746C2.65712 11.3417 2.45308 11.1795 2.28304 11.0212C2.08285 10.8347 1.81888 10.5554 1.61972 10.1539C1.36893 9.64832 1.26584 9.08224 1.3223 8.52069C1.36714 8.07476 1.51571 7.72032 1.63732 7.47528C1.74062 7.26715 1.87443 7.04347 1.98414 6.86005L2.48605 6.02026C2.58969 5.84669 2.71714 5.63326 2.84534 5.45151C2.9971 5.23637 3.22655 4.95096 3.5765 4.70565C4.01966 4.39498 4.53862 4.20999 5.07837 4.17027C5.50458 4.1389 5.86284 4.21481 6.11646 4.28544C6.33072 4.34511 6.56444 4.4298 6.75451 4.49867L7.69141 4.83775L7.69394 4.8363C7.72844 4.8166 7.7631 4.79712 7.79791 4.77788L7.80068 4.77635L7.94225 3.95571C7.97723 3.7525 8.02011 3.50334 8.07542 3.2843C8.14077 3.0255 8.25461 2.67075 8.49926 2.31147C8.80849 1.85736 9.23648 1.49689 9.73655 1.26937C10.1322 1.08936 10.5011 1.03749 10.7673 1.01709ZM14.0938 4.3363C14.011 3.85634 13.9696 3.61637 13.8476 3.43717C13.7445 3.2858 13.6019 3.16564 13.4352 3.0898C13.2378 3.00002 12.9943 3.00002 12.5073 3.00002H11.4927C11.0057 3.00002 10.7621 3.00002 10.5648 3.0898C10.3981 3.16564 10.2555 3.2858 10.1524 3.43717C10.0304 3.61637 9.98895 3.85634 9.90615 4.3363L9.75012 5.24064C9.69445 5.56333 9.66662 5.72467 9.60765 5.84869C9.54975 5.97047 9.50241 6.03703 9.40636 6.13166C9.30853 6.22804 9.12753 6.3281 8.76554 6.52822C8.73884 6.54298 8.71227 6.55791 8.68582 6.57302C8.33956 6.77078 8.16643 6.86966 8.03785 6.90314C7.91158 6.93602 7.83293 6.94279 7.70289 6.93196C7.57049 6.92094 7.42216 6.86726 7.12551 6.7599L6.11194 6.39308C5.66271 6.2305 5.43809 6.14921 5.22515 6.16488C5.04524 6.17811 4.87225 6.23978 4.72453 6.34333C4.5497 6.46589 4.42715 6.67094 4.18206 7.08103L3.72269 7.84965C3.46394 8.2826 3.33456 8.49907 3.31227 8.72078C3.29345 8.90796 3.32781 9.09665 3.41141 9.26519C3.51042 9.4648 3.7078 9.62177 4.10256 9.9357L4.82745 10.5122C5.07927 10.7124 5.20518 10.8126 5.28411 10.9199C5.36944 11.036 5.40583 11.1114 5.44354 11.2504C5.47844 11.379 5.47844 11.586 5.47844 12C5.47844 12.414 5.47844 12.621 5.44354 12.7497C5.40582 12.8887 5.36944 12.9641 5.28413 13.0801C5.20518 13.1875 5.07927 13.2876 4.82743 13.4879L4.10261 14.0643C3.70785 14.3783 3.51047 14.5352 3.41145 14.7349C3.32785 14.9034 3.29349 15.0921 3.31231 15.2793C3.33461 15.501 3.46398 15.7174 3.72273 16.1504L4.1821 16.919C4.4272 17.3291 4.54974 17.5342 4.72457 17.6567C4.8723 17.7603 5.04528 17.8219 5.2252 17.8352C5.43813 17.8508 5.66275 17.7695 6.11199 17.607L7.12553 17.2402C7.42216 17.1328 7.5705 17.0791 7.7029 17.0681C7.83294 17.0573 7.91159 17.064 8.03786 17.0969C8.16644 17.1304 8.33956 17.2293 8.68582 17.427C8.71228 17.4421 8.73885 17.4571 8.76554 17.4718C9.12753 17.6719 9.30853 17.772 9.40635 17.8684C9.50241 17.963 9.54975 18.0296 9.60765 18.1514C9.66662 18.2754 9.69445 18.4367 9.75012 18.7594L9.90615 19.6637C9.98895 20.1437 10.0304 20.3837 10.1524 20.5629C10.2555 20.7142 10.3981 20.8344 10.5648 20.9102C10.7621 21 11.0057 21 11.4927 21H12.5073C12.9943 21 13.2378 21 13.4352 20.9102C13.6019 20.8344 13.7445 20.7142 13.8476 20.5629C13.9696 20.3837 14.011 20.1437 14.0938 19.6637L14.2499 18.7594C14.3055 18.4367 14.3334 18.2754 14.3923 18.1514C14.4502 18.0296 14.4976 17.963 14.5936 17.8684C14.6915 17.772 14.8725 17.6719 15.2344 17.4718C15.2611 17.4571 15.2877 17.4421 15.3141 17.427C15.6604 17.2293 15.8335 17.1304 15.9621 17.0969C16.0884 17.064 16.167 17.0573 16.2971 17.0681C16.4295 17.0791 16.5778 17.1328 16.8744 17.2402L17.888 17.607C18.3372 17.7696 18.5619 17.8509 18.7748 17.8352C18.9547 17.8219 19.1277 17.7603 19.2754 17.6567C19.4502 17.5342 19.5728 17.3291 19.8179 16.919L20.2773 16.1504C20.536 15.7175 20.6654 15.501 20.6877 15.2793C20.7065 15.0921 20.6721 14.9034 20.5885 14.7349C20.4895 14.5353 20.2921 14.3783 19.8974 14.0643L19.1726 13.4879C18.9207 13.2876 18.7948 13.1875 18.7159 13.0801C18.6306 12.9641 18.5942 12.8887 18.5564 12.7497C18.5215 12.6211 18.5215 12.414 18.5215 12C18.5215 11.586 18.5215 11.379 18.5564 11.2504C18.5942 11.1114 18.6306 11.036 18.7159 10.9199C18.7948 10.8126 18.9207 10.7124 19.1725 10.5122L19.8974 9.9357C20.2922 9.62176 20.4896 9.46479 20.5886 9.26517C20.6722 9.09664 20.7065 8.90795 20.6877 8.72076C20.6654 8.49906 20.5361 8.28259 20.2773 7.84964L19.8179 7.08102C19.5728 6.67093 19.4503 6.46588 19.2755 6.34332C19.1277 6.23977 18.9548 6.1781 18.7748 6.16486C18.5619 6.14919 18.3373 6.23048 17.888 6.39307L16.8745 6.75989C16.5778 6.86725 16.4295 6.92093 16.2971 6.93195C16.167 6.94278 16.0884 6.93601 15.9621 6.90313C15.8335 6.86965 15.6604 6.77077 15.3142 6.57302C15.2877 6.55791 15.2611 6.54298 15.2345 6.52822C14.8725 6.3281 14.6915 6.22804 14.5936 6.13166C14.4976 6.03703 14.4502 5.97047 14.3923 5.84869C14.3334 5.72467 14.3055 5.56332 14.2499 5.24064L14.0938 4.3363Z" fill="currentColor"></path></svg></div></div></a></li> <li><a highlight-on="none" href="#cv-share" class="nav-link"><div><div><svg xmlns="http://www.w3.org/2000/svg" width="1.2em" height="1.2em" viewBox="0 0 24 24" fill="currentColor" style="vertical-align:middle;"><path d="M18 8h-2a1 1 0 0 0 0 2h2v8H6v-8h2a1 1 0 0 0 0-2H6a2 2 0 0 0-2 2v8a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2v-8a2 2 0 0 0-2-2z"></path> <path d="M11 6.41V12a1 1 0 0 0 2 0V6.41l1.29 1.3a1 1 0 0 0 1.42 0a1 1 0 0 0 0-1.42l-3-3a1 1 0 0 0-1.42 0l-3 3a1 1 0 1 0 1.42 1.42L11 6.41z"></path></svg></div></div></a></li> <li><a href="https://github.com/custardui/custardui" target="_blank" class="nav-link"><span><span aria-hidden="true" class="fab fa-github"></span></span></a></li> <!--]--></ul></div><div class="navbar-right" data-v-94b60ff6><ul class="navbar-nav" data-v-94b60ff6><!--[--><li><form class="navbar-form"><div style="position:relative;" class="dropdown" data-v-103d5c4e><!--[--><input value="" data-bs-toggle="dropdown" type="text" class="form-control" placeholder="Search" autocomplete="off" data-v-103d5c4e><div class="form-control placeholder-div-hidden" data-v-103d5c4e>Search</div><!--]--><ul class="dropdown-menu search-dropdown-menu dropdown-menu-hidden dropdown-menu-end" data-v-103d5c4e><!--[--><!--]--></ul></div></form></li><!--]--></ul><!----></div></div></nav><div style="display:none;" class="lower-navbar-container" data-v-94b60ff6><!--[--><!----><!----><!--]--></div></div></header> <div id="flex-body"><div id="content-wrapper"><div class="cv-hero-title"><span class="cv-custard">Custard</span><span class="cv-ui">U<span style="font-family:Georgia, serif;">I</span></span></div> <div class="cv-hero-tagline">Let readers <span class="hero-text-highlight">customise</span> your static web pages!</div> <div class="cv-hero-accent"></div> <p>Add CustardUI to any static site and let readers personalise their experience. Hide sections, set preferences and share exactly the right content with others. No backend required.</p> <p><a href="/devdocs/authorGuide"><span aria-hidden="true" class="fa-solid fa-book"></span> Read the docs</a> • <a href="https://github.com/custardui/custardui"><span aria-hidden="true" class="fa-brands fa-github"></span> View on GitHub</a> • <a href="https://www.npmjs.com/package/@custardui/custardui"><span aria-hidden="true" class="fa-solid fa-cube"></span> npm package</a></p> <br> <h2 class="cv-section-title" id="what-it-can-do">What it can do<a class="fa fa-anchor" href="#what-it-can-do" onclick="event.stopPropagation()"></a></h2> <p class="cv-section-header" style="margin-top:0rem;">Hide irrelevant sections; Collapse less relevant sections.</p> <p>Let readers collapse what they don't need. Their choice sticks across pages and sessions.</p> <div><div class="cv-browser-triple"><div class="cv-browser-triple-bar"><div class="cv-browser-triple-dots"><div class="cv-browser-triple-dot"></div> <div class="cv-browser-triple-dot"></div> <div class="cv-browser-triple-dot"></div></div> <div class="cv-browser-triple-url">https://project-documentation.org/best-practices</div> <div class="cv-browser-triple-menu"><div class="cv-browser-triple-menu-dot"></div> <div class="cv-browser-triple-menu-dot"></div> <div class="cv-browser-triple-menu-dot"></div></div></div> <div class="cv-browser-triple-panes"><div class="cv-browser-triple-col"><div class="cv-browser-triple-pane"><h4 id="dependency-injection">Dependency Injection<a class="fa fa-anchor" href="#dependency-injection" onclick="event.stopPropagation()"></a></h4> <p><strong>Toggle:</strong> <cv-toggle-control toggle-id="code-example-hide" inline></cv-toggle-control></p> <p>Dependency Injection (DI) is a technique where an object's dependencies are provided externally rather than created by the object itself. This reduces coupling and makes code easier to test.</p> <cv-toggle toggle-id="code-example-hide" show-label show-peek-border><pre><code class="hljs java"><span><span class="hljs-comment">// Without DI — tightly coupled</span>
</span><span><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">UserService</span> </span>{
</span><span> <span class="hljs-keyword">private</span> Database db = <span class="hljs-keyword">new</span> Database();
</span><span>}
</span><span>
</span><span><span class="hljs-comment">// With DI — dependency is injected</span>
</span><span><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">UserService</span> </span>{
</span><span> <span class="hljs-keyword">private</span> Database db;
</span><span>
</span><span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">UserService</span><span class="hljs-params">(Database db)</span> </span>{
</span><span> <span class="hljs-keyword">this</span>.db = db;
</span><span> }
</span><span>}
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre></cv-toggle> <p><span class="dimmed">Prefer constructor injection over field injection — it makes dependencies explicit and the class easier to test.</span></p></div></div> <div class="cv-browser-triple-col"><div class="cv-browser-triple-pane"><h4 id="dependency-injection-2">Dependency Injection<a class="fa fa-anchor" href="#dependency-injection-2" onclick="event.stopPropagation()"></a></h4> <p><strong>Toggle:</strong> <cv-toggle-control toggle-id="code-example-peek" inline></cv-toggle-control></p> <p>Dependency Injection (DI) is a technique where an object's dependencies are provided externally rather than created by the object itself. This reduces coupling and makes code easier to test.</p> <cv-toggle toggle-id="code-example-peek" show-label show-peek-border><pre><code class="hljs java"><span><span class="hljs-comment">// Without DI — tightly coupled</span>
</span><span><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">UserService</span> </span>{
</span><span> <span class="hljs-keyword">private</span> Database db = <span class="hljs-keyword">new</span> Database();
</span><span>}
</span><span>
</span><span><span class="hljs-comment">// With DI — dependency is injected</span>
</span><span><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">UserService</span> </span>{
</span><span> <span class="hljs-keyword">private</span> Database db;
</span><span>
</span><span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">UserService</span><span class="hljs-params">(Database db)</span> </span>{
</span><span> <span class="hljs-keyword">this</span>.db = db;
</span><span> }
</span><span>}
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre></cv-toggle> <p><span class="dimmed">Prefer constructor injection over field injection — it makes dependencies explicit and the class easier to test.</span></p></div></div> <div class="cv-browser-triple-col"><div class="cv-browser-triple-pane"><h4 id="dependency-injection-3">Dependency Injection<a class="fa fa-anchor" href="#dependency-injection-3" onclick="event.stopPropagation()"></a></h4> <p><strong>Toggle:</strong> <cv-toggle-control toggle-id="code-example-show" inline></cv-toggle-control></p> <p>Dependency Injection (DI) is a technique where an object's dependencies are provided externally rather than created by the object itself. This reduces coupling and makes code easier to test.</p> <cv-toggle toggle-id="code-example-show" show-label show-peek-border><pre><code class="hljs java"><span><span class="hljs-comment">// Without DI — tightly coupled</span>
</span><span><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">UserService</span> </span>{
</span><span> <span class="hljs-keyword">private</span> Database db = <span class="hljs-keyword">new</span> Database();
</span><span>}
</span><span>
</span><span><span class="hljs-comment">// With DI — dependency is injected</span>
</span><span><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">UserService</span> </span>{
</span><span> <span class="hljs-keyword">private</span> Database db;
</span><span>
</span><span> <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">UserService</span><span class="hljs-params">(Database db)</span> </span>{
</span><span> <span class="hljs-keyword">this</span>.db = db;
</span><span> }
</span><span>}
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre></cv-toggle> <p><span class="dimmed">Prefer constructor injection over field injection — it makes dependencies explicit and the class easier to test.</span></p></div></div></div></div></div> <p><span class="dimmed">The same page, three toggle states, where each reader can set their own peferences and see only what they chose to.</span></p> <hr> <p class="cv-section-header">Set the default tab in tab groups.</p> <p>Let readers switch to their preferred view for tabgroups once, and this selection persists across your site.</p> <ul><li>Hover and click the <span aria-hidden="true" class="fa-solid fa-bookmark"></span> icon on any tab, or simply double-click it, to set it as your default across the site.</li> <li>Prefer a cleaner view? Hide the tab bar entirely in the settings modal through the <span aria-hidden="true" class="fa-solid fa-gear"></span> icon on the left. Click the option to <br> <em>"show only the selected tab"</em> to hide the navigation headers and show only your preferred content!</li></ul> <div><div class="cv-browser-split"><div class="cv-browser-split-bar"><div class="cv-browser-split-dots"><div class="cv-browser-split-dot"></div> <div class="cv-browser-split-dot"></div> <div class="cv-browser-split-dot"></div></div> <div class="cv-browser-split-urls"><div class="cv-browser-split-url">https://course-website.org/textbook/sorting</div> <div class="cv-browser-split-url-divider"></div> <div class="cv-browser-split-url">https://course-website.org/textbook/searching</div></div> <div class="cv-browser-split-menu"><div class="cv-browser-split-menu-dot"></div> <div class="cv-browser-split-menu-dot"></div> <div class="cv-browser-split-menu-dot"></div></div></div> <div class="cv-browser-split-panes"><div class="cv-browser-split-pane"><h4 id="insertion-sort">Insertion Sort<a class="fa fa-anchor" href="#insertion-sort" onclick="event.stopPropagation()"></a></h4> <p><span class="dimmed">Insertion Sort builds a sorted array one element at a time by picking each element and placing it in its correct position. Simple and efficient for small or nearly sorted arrays.</span></p> <cv-tabgroup group-id="tab-group-example" nav="auto"><cv-tab tab-id="javascript" header="JavaScript"><pre><code class="hljs javascript"><span><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">insertionSort</span>(<span class="hljs-params">arr</span>) </span>{
</span><span> <span class="hljs-keyword">for</span> (<span class="hljs-keyword">let</span> i = <span class="hljs-number">1</span>; i < arr.length; i++) {
</span><span> <span class="hljs-keyword">let</span> key = arr[i];
</span><span> <span class="hljs-keyword">let</span> j = i - <span class="hljs-number">1</span>;
</span><span> <span class="hljs-keyword">while</span> (j >= <span class="hljs-number">0</span> && arr[j] > key) {
</span><span> arr[j + <span class="hljs-number">1</span>] = arr[j];
</span><span> j--;
</span><span> }
</span><span> arr[j + <span class="hljs-number">1</span>] = key;
</span><span> }
</span><span>}
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre></cv-tab> <cv-tab tab-id="java" header="Java"><pre><code class="hljs java"><span><span class="hljs-function"><span class="hljs-keyword">void</span> <span class="hljs-title">insertionSort</span><span class="hljs-params">(<span class="hljs-keyword">int</span>[] arr)</span> </span>{
</span><span> <span class="hljs-keyword">for</span> (<span class="hljs-keyword">int</span> i = <span class="hljs-number">1</span>; i < arr.length; i++) {
</span><span> <span class="hljs-keyword">int</span> key = arr[i];
</span><span> <span class="hljs-keyword">int</span> j = i - <span class="hljs-number">1</span>;
</span><span> <span class="hljs-keyword">while</span> (j >= <span class="hljs-number">0</span> && arr[j] > key) {
</span><span> arr[j + <span class="hljs-number">1</span>] = arr[j];
</span><span> j--;
</span><span> }
</span><span> arr[j + <span class="hljs-number">1</span>] = key;
</span><span> }
</span><span>}
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre></cv-tab> <cv-tab tab-id="python" header="Python"><pre><code class="hljs python"><span><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">insertion_sort</span>(<span class="hljs-params">arr</span>):</span>
</span><span> <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> <span class="hljs-built_in">range</span>(<span class="hljs-number">1</span>, <span class="hljs-built_in">len</span>(arr)):
</span><span> key = arr[i]
</span><span> j = i - <span class="hljs-number">1</span>
</span><span> <span class="hljs-keyword">while</span> j >= <span class="hljs-number">0</span> <span class="hljs-keyword">and</span> arr[j] > key:
</span><span> arr[j + <span class="hljs-number">1</span>] = arr[j]
</span><span> j -= <span class="hljs-number">1</span>
</span><span> arr[j + <span class="hljs-number">1</span>] = key
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre></cv-tab></cv-tabgroup> <p><span class="dimmed">Time complexity: O(n²) worst case, O(n) best case on nearly sorted arrays.</span></p></div> <div class="cv-browser-split-pane"><h4 id="binary-search">Binary Search<a class="fa fa-anchor" href="#binary-search" onclick="event.stopPropagation()"></a></h4> <p><span class="dimmed">Binary Search finds a target value in a sorted array by repeatedly halving the search space. Far more efficient than linear search for large datasets.</span></p> <cv-tabgroup group-id="tab-group-example" nav="auto"><cv-tab tab-id="javascript" header="JavaScript"><pre><code class="hljs javascript"><span><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">binarySearch</span>(<span class="hljs-params">arr, target</span>) </span>{
</span><span> <span class="hljs-keyword">let</span> left = <span class="hljs-number">0</span>, right = arr.length - <span class="hljs-number">1</span>;
</span><span> <span class="hljs-keyword">while</span> (left <= right) {
</span><span> <span class="hljs-keyword">const</span> mid = <span class="hljs-built_in">Math</span>.floor((left + right) / <span class="hljs-number">2</span>);
</span><span> <span class="hljs-keyword">if</span> (arr[mid] === target) <span class="hljs-keyword">return</span> mid;
</span><span> <span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> (arr[mid] < target) left = mid + <span class="hljs-number">1</span>;
</span><span> <span class="hljs-keyword">else</span> right = mid - <span class="hljs-number">1</span>;
</span><span> }
</span><span> <span class="hljs-keyword">return</span> -<span class="hljs-number">1</span>;
</span><span>}
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre></cv-tab> <cv-tab tab-id="java" header="Java"><pre><code class="hljs java"><span><span class="hljs-function"><span class="hljs-keyword">int</span> <span class="hljs-title">binarySearch</span><span class="hljs-params">(<span class="hljs-keyword">int</span>[] arr, <span class="hljs-keyword">int</span> target)</span> </span>{
</span><span> <span class="hljs-keyword">int</span> left = <span class="hljs-number">0</span>, right = arr.length - <span class="hljs-number">1</span>;
</span><span> <span class="hljs-keyword">while</span> (left <= right) {
</span><span> <span class="hljs-keyword">int</span> mid = (left + right) / <span class="hljs-number">2</span>;
</span><span> <span class="hljs-keyword">if</span> (arr[mid] == target) <span class="hljs-keyword">return</span> mid;
</span><span> <span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> (arr[mid] < target) left = mid + <span class="hljs-number">1</span>;
</span><span> <span class="hljs-keyword">else</span> right = mid - <span class="hljs-number">1</span>;
</span><span> }
</span><span> <span class="hljs-keyword">return</span> -<span class="hljs-number">1</span>;
</span><span>}
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre></cv-tab> <cv-tab tab-id="python" header="Python"><pre><code class="hljs python"><span><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">binary_search</span>(<span class="hljs-params">arr, target</span>):</span>
</span><span> left, right = <span class="hljs-number">0</span>, <span class="hljs-built_in">len</span>(arr) - <span class="hljs-number">1</span>
</span><span> <span class="hljs-keyword">while</span> left <= right:
</span><span> mid = (left + right) // <span class="hljs-number">2</span>
</span><span> <span class="hljs-keyword">if</span> arr[mid] == target:
</span><span> <span class="hljs-keyword">return</span> mid
</span><span> <span class="hljs-keyword">elif</span> arr[mid] < target:
</span><span> left = mid + <span class="hljs-number">1</span>
</span><span> <span class="hljs-keyword">else</span>:
</span><span> right = mid - <span class="hljs-number">1</span>
</span><span> <span class="hljs-keyword">return</span> -<span class="hljs-number">1</span>
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre></cv-tab></cv-tabgroup> <p><span class="dimmed">Time complexity: O(log n). Requires the array to be sorted before searching.</span></p></div></div></div></div> <p><span class="dimmed">Switch to Python on either page, and every code example across the site follows.</span></p> <hr> <p class="cv-section-header">Tweak placeholder text to match the reader's profile.</p> <p>Let readers personalise your page to their needs.</p> <ul><li>Define a placeholder once, readers fill it in, and every instance across the site updates instantly. No backend required.</li></ul> <div><div class="cv-browser-single"><div class="cv-browser-single-bar"><div class="cv-browser-single-dots"><div class="cv-browser-single-dot"></div> <div class="cv-browser-single-dot"></div> <div class="cv-browser-single-dot"></div></div> <div class="cv-browser-single-url">https://course-website.org/admin/setup</div> <div class="cv-browser-triple-menu"><div class="cv-browser-triple-menu-dot"></div> <div class="cv-browser-triple-menu-dot"></div> <div class="cv-browser-triple-menu-dot"></div></div></div> <div class="cv-browser-single-body"><h4 id="course-instructions-and-guide"><span aria-hidden="true" class="fa-solid fa-graduation-cap"></span> Course Instructions and Guide<a class="fa fa-anchor" href="#course-instructions-and-guide" onclick="event.stopPropagation()"></a></h4> <p>Follow the steps below to set up your individual project repository. Enter your GitHub username once — all links and commands on this page will update to match.</p> <p>Enter your GitHub username here: <cv-placeholder-input name="username" hint="e.g. johndoe" layout="inline" appearance="underline"></cv-placeholder-input>
<img src="https://github.com/[[username : github ]].png" style="height:1.8rem;vertical-align:middle;border-radius:50%;margin-left:0.5rem;" class="cv-bind" alt="GitHub Avatar"></p> <p><strong>Step 1 — Fork and accept the invitation</strong></p> <p>Accept the GitHub Classroom invitation using your account at <span aria-hidden="true" class="fa-brands fa-github"></span> <a href="https://github.com[[username ? /$ : ]]" class="cv-bind" target="_blank">github.com[[username ? /$ : ]]</a>. This will create a pre-configured fork of the exercise repository under your account.</p> <p><strong>Step 2 — Clone and get started</strong></p> <p>Run the command below to clone your repository to your local machine, then make your first commit to confirm everything is working.</p> <pre><code class="hljs"><span>git clone https://[[ username ? github.com/cs2103t/$-ip.git : your-repo-link ]]
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre><p><span class="dimmed">Stuck? Raise an issue on the forum and include your GitHub username so tutors can locate your repository quickly.</span></p></div></div></div> <p><span class="dimmed">Type a username above — every link, command, and path updates live.</span></p> <hr> <p class="cv-section-header">Share selected parts of a page with others.</p> <p>Link anyone directly to the exact paragraph, step, or answer they need. No more "scroll down and look for it."</p> <div><div class="cv-browser-split"><div class="cv-browser-split-bar"><div class="cv-browser-split-dots"><div class="cv-browser-split-dot"></div> <div class="cv-browser-split-dot"></div> <div class="cv-browser-split-dot"></div></div> <div class="cv-browser-split-urls"><div class="cv-browser-split-url">https://course-website.org/textbook/week9</div> <div class="cv-browser-split-url-divider"></div> <div class="cv-browser-split-url">https://course-website.org/admin/faq</div></div> <div class="cv-browser-split-menu"><div class="cv-browser-split-menu-dot"></div> <div class="cv-browser-split-menu-dot"></div> <div class="cv-browser-split-menu-dot"></div></div></div> <div class="cv-browser-split-panes"><div class="cv-browser-split-pane"><h4 id="liskov-substitution-principle">Liskov Substitution Principle<a class="fa fa-anchor" href="#liskov-substitution-principle" onclick="event.stopPropagation()"></a></h4> <p>The Liskov Substitution Principle (LSP) states that objects of a subclass should be substitutable for objects of the superclass without altering the correctness of the program.</p> <div id="lsp-violation-example"><p><strong>Common violation:</strong> Overriding a method in a subclass to throw an exception or do nothing breaks substitutability — callers written against the superclass will break unexpectedly.</p> <p><a href="/devdocs/?cv-box=lsp-violation-example"><span aria-hidden="true" class="fa-solid fa-link"></span> Share</a> · <a href="/devdocs/?cv-box=lsp-violation-example%3Ared%3Abr%3AWatch%2520out%2520for%2520this%2521"><span aria-hidden="true" class="fa-solid fa-link"></span> Share with note</a></p></div> <p>The principle encourages designing inheritance hierarchies where subclasses genuinely extend, rather than contradict, the behaviour of their parent.</p></div> <div class="cv-browser-split-pane"><h4 id="frequently-asked-questions">Frequently Asked Questions<a class="fa fa-anchor" href="#frequently-asked-questions" onclick="event.stopPropagation()"></a></h4> <p><strong>When is the submission deadline?</strong></p> <p>All submissions are due Friday 11:59 PM. Push to your <code class="hljs inline no-lang">main</code> branch on GitHub.</p> <div id="faq-team-repo"><p><strong>Where do I find my team repo?</strong></p> <p>Your team repo is at <code class="hljs inline no-lang">github.com/course-[team-id]/project</code>. If you cannot access it, check that you have accepted the GitHub Classroom invitation.</p> <p><a href="/devdocs/?cv-box=faq-team-repo"><span aria-hidden="true" class="fa-solid fa-link"></span> Share</a> · <a href="/devdocs/?cv-box=faq-team-repo%3A%3Atl%3ARefer%2520to%2520this%2521"><span aria-hidden="true" class="fa-solid fa-link"></span> Share with note</a></p></div> <p><strong>How do I add my tutor as a collaborator?</strong></p> <p>Go to your repo → Settings → Collaborators → Add your tutor's GitHub username.</p></div></div></div></div> <p><span class="dimmed">Click "Share" for a plain boxed element, or "Share with note" to include a message and color. The URL encodes the element, color, position, and note — the recipient lands directly on that section.</span></p> <p><strong>Generating share links is built in.</strong> Add <code class="hljs inline no-lang">#cv-share</code> to any page URL to enter share mode. Hover over any element on the page, add a note, and CustardUI generates the shareable URL for you. Links use content fingerprinting to stay robust even if the page text changes slightly.</p> <hr> <p class="cv-section-header">Share your customisations with others.</p> <p>Send a custom link that opens the page exactly as you intend, with placeholders pre-filled, sections pre-set. The recipient sees a personalised view instantly, no configuration needed.</p> <div><div class="cv-browser-single"><div class="cv-browser-single-bar"><div class="cv-browser-single-dots"><div class="cv-browser-single-dot"></div> <div class="cv-browser-single-dot"></div> <div class="cv-browser-single-dot"></div></div> <div class="cv-browser-single-url">https://course.org/setup?ph=username:johndoe,name:John%20Doe&t-hide=optional-steps</div> <div class="cv-browser-triple-menu"><div class="cv-browser-triple-menu-dot"></div> <div class="cv-browser-triple-menu-dot"></div> <div class="cv-browser-triple-menu-dot"></div></div></div> <div class="cv-browser-single-body"><h4 id="course-setup-guide">Course Setup Guide<a class="fa fa-anchor" href="#course-setup-guide" onclick="event.stopPropagation()"></a></h4> <p><span class="dimmed">This page was shared with your details pre-filled.</span></p> <p>Welcome, <strong>John Doe</strong>! Here are your setup instructions.</p> <hr> <p><strong>Step 1 — Accept the classroom invitation</strong></p> <p>Accept the invitation at <a href="https://github.com/johndoe" target="_blank">github.com/johndoe</a>. This will create your personal fork of the exercise repository.</p> <p><strong>Step 2 — Clone your repository</strong></p> <pre><code class="hljs bash"><span>git <span class="hljs-built_in">clone</span> https://github.com/cs2103t/johndoe-ip.git
</span><span><span class="hljs-built_in">cd</span> johndoe-ip
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre><p><strong>Step 3 — Push your first commit</strong></p> <pre><code class="hljs bash"><span>git add .
</span><span>git commit -m <span class="hljs-string">"Initial commit"</span>
</span><span>git push origin main
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre><p><span class="dimmed">Optional troubleshooting steps are hidden for this view.</span></p></div></div></div> <p>The URL that produced this view:</p> <pre><code class="hljs"><span>?ph=username:johndoe,name:John%20Doe&t-hide=optional-steps
</span></code><div class="function-btn-container"><button onclick="copyCodeBlock(this)" class="function-btn d-print-none">
<div class="tooltip-container">
<span class="tooltiptext">Copy</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path d="M 11.273438 0 L 2.546875 0 C 1.746094 0 1.089844 0.613281 1.089844
1.363281 L 1.089844 10.910156 L 2.546875 10.910156 L 2.546875 1.363281 L 11.273438
1.363281 Z M 13.453125 2.726562 L 5.453125 2.726562 C 4.65625 2.726562 4 3.339844 4
4.089844 L 4 13.636719 C 4 14.386719 4.65625 15 5.453125 15 L 13.453125 15 C 14.253906
15 14.910156 14.386719 14.910156 13.636719 L 14.910156 4.089844 C 14.910156 3.339844
14.253906 2.726562 13.453125 2.726562 Z M 13.453125 13.636719 L 5.453125 13.636719 L
5.453125 4.089844 L 13.453125 4.089844 Z M 13.453125 13.636719 "></path>
</g>
</svg>
</div>
</div>
</button><button onclick="toggleCodeBlockWrap(this)" class="function-btn d-print-none wrap-button">
<div class="tooltip-container">
<span class="tooltiptext">Wrap Text</span>
<div class="function-btn-body">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="18" height="18" viewBox="0 0 18 18" version="1.1">
<g id="surface1">
<path id="path17964" d="M 1.109375 0 L 1.109375 2.5351562 L 2.0410156 2.5351562 L
2.0410156 0.93164062 L 4.8203125 0.93164062 L 4.8203125 9.3222656 L 3.4746094
9.3222656 L 3.4746094 10.144531 L 8.8027344 10.144531 L 8.8027344 9.3222656 L
7.4492188 9.3222656 L 7.4492188 0.93164062 L 10.25 0.93164062 L 10.25 2.5351562 L
11.166016 2.5351562 L 11.166016 0 L 1.109375 0 z M 10.84375 5.1054688 L 10.84375
6.6074219 C 12.268027 6.6074219 13.40625 7.7456444 13.40625 9.1699219 C 13.40625
10.185673 12.827237 11.055036 11.978516 11.470703 L 11.978516 9.5175781 L 7.1386719
12.3125 L 11.978516 15.105469 L 11.978516 13.072266 C 13.66701 12.577757 14.910156
11.012746 14.910156 9.1699219 C 14.910156 6.9333638 13.080308 5.1054688 10.84375
5.1054688 z "></path>
</g>
</svg>
</div>
</div>
</button></div></pre><p><span class="dimmed"><code class="hljs inline no-lang">ph=</code> pre-fills placeholders. <code class="hljs inline no-lang">t-hide=</code> hides toggle sections. A teacher can generate this link in seconds and send it directly to a student.</span></p> <hr> <p class="cv-section-header">Advanced: let adopters create adaptations of your site.</p> <p>Authors can expose selected content, such as logos, images, labels, and branding text, as adaptation points. Each organisation that adopts the site supplies a config preset overriding those values. The result is a single deployment that feels native to every audience it serves.</p> <div><div class="cv-browser-split"><div class="cv-browser-split-bar"><div class="cv-browser-split-dots"><div class="cv-browser-split-dot"></div> <div class="cv-browser-split-dot"></div> <div class="cv-browser-split-dot"></div></div> <div class="cv-browser-split-urls"><div class="cv-browser-split-url">onboarding.example.com#/alpha-corp</div> <div class="cv-browser-split-url-divider"></div> <div class="cv-browser-split-url">onboarding.example.com#/beta-labs</div></div> <div class="cv-browser-split-menu"><div class="cv-browser-split-menu-dot"></div> <div class="cv-browser-split-menu-dot"></div> <div class="cv-browser-split-menu-dot"></div></div></div> <div class="cv-browser-split-panes"><div class="cv-browser-split-pane"><h5 id="alpha-corp-onboarding-guide"><span aria-hidden="true" class="fa-solid fa-building"></span> <strong>Alpha Corp — Onboarding Guide</strong><a class="fa fa-anchor" href="#alpha-corp-onboarding-guide" onclick="event.stopPropagation()"></a></h5> <p>Welcome to <strong>Alpha Corp</strong>! Follow the steps below to get set up.</p> <p><strong>Exercise 1</strong> <cv-label color="#3b82f6">OPTIONAL</cv-label></p> <p>Complete the introductory module at your own pace.</p> <p><strong>Exercise 2</strong> <cv-label color="#3b82f6">OPTIONAL</cv-label></p> <p>Read through the team handbook before your first standup.</p> <p><span class="dimmed">Powered by the <code class="hljs inline no-lang">alpha-corp</code> adaptation preset.</span></p></div> <div class="cv-browser-split-pane"><h5 id="beta-labs-onboarding-guide"><span aria-hidden="true" class="fa-solid fa-flask"></span> <strong>Beta Labs — Onboarding Guide</strong><a class="fa fa-anchor" href="#beta-labs-onboarding-guide" onclick="event.stopPropagation()"></a></h5> <p>Welcome to <strong>Beta Labs</strong>! Follow the steps below to get set up.</p> <p><strong>Exercise 1</strong> <cv-label color="#ef4444">COMPULSORY</cv-label></p> <p>Complete the introductory module before your first day.</p> <p><strong>Exercise 2</strong> <cv-label color="#ef4444">COMPULSORY</cv-label></p> <p>Read through the team handbook before your first standup.</p> <p><span class="dimmed">Powered by the <code class="hljs inline no-lang">beta-labs</code> adaptation preset.</span></p></div></div></div></div> <p><span class="dimmed">Same page, same deployment — different logo, different branding, different labels. Each organisation supplies a config preset; the site adapts automatically.</span></p> <hr> <br> <h2 class="cv-section-title" id="how-it-works">How it works<a class="fa fa-anchor" href="#how-it-works" onclick="event.stopPropagation()"></a></h2> <p>All reader preferences, tab selections, toggle states, and placeholder values are saved in the browser's localStorage. Nothing is sent to a server, nothing leaves the device. You define exactly what can be customised; readers adjust within those boundaries.</p> <p>CustardUI works across all modern browsers with no configuration needed on the reader's end.</p> <hr> <br> <h2 class="cv-section-title" id="works-with-any-static-site">Works with any static site<a class="fa fa-anchor" href="#works-with-any-static-site" onclick="event.stopPropagation()"></a></h2> <p>CustardUI is open source under the MIT licence. Add it to any static site with a single script tag without needing any build step, npm install, or backend.</p> <p>Built and tested with <a href="https://markbind.org/">MarkBind</a>. Also works with Jekyll, Docusaurus, React static sites, and any site that serves plain HTML.</p> <p><a href="https://github.com/custardui/custardui"><span aria-hidden="true" class="fa-brands fa-github"></span> View on GitHub</a> • <a href="https://www.npmjs.com/package/@custardui/custardui"><span aria-hidden="true" class="fa-solid fa-cube"></span> npm package</a></p> <hr> <br> <h2 class="cv-section-title" id="how-to-get-started">How to Get Started<a class="fa fa-anchor" href="#how-to-get-started" onclick="event.stopPropagation()"></a></h2> <p>Up and running in minutes. Add one script tag. Write one config file.</p> <div class="cv-setup-steps"><div class="cv-setup-step"><div class="cv-step-num">1</div> <div><h4 id="add-the-script-tag">Add the script tag<a class="fa fa-anchor" href="#add-the-script-tag" onclick="event.stopPropagation()"></a></h4> <p>Drop one line of the CustardUI CDN script into your base layout or <code class="hljs inline no-lang"><head></code> template.
</p></div><p></p></div> <div class="cv-setup-step"><div class="cv-step-num">2</div> <div><h4 id="create-your-config">Create your config<a class="fa fa-anchor" href="#create-your-config" onclick="event.stopPropagation()"></a></h4> <p>Add a <code class="hljs inline no-lang">custardui.config.json</code> to your site root. Define what readers can customise.
</p></div><p></p></div></div> <p>Done. Check the author guide for components and examples.</p> <br> <br> <div class="cv-cta-actions"><a href="/devdocs/authorGuide/gettingStarted.html" class="cv-btn-secondary"><span><span aria-hidden="true" class="fa-solid fa-book"></span></span> Read the Author Guide</a></div> <div class="cv-logo-row"><div class="cv-logo-item"><img src="/devdocs/images/logo-art/custard-click.png" alt="Custard Click"></div> <div class="cv-logo-item"><img src="/devdocs/images/logo-art/custard-half.png" alt="Custard Half"></div> <div class="cv-logo-item"><img src="/devdocs/images/logo-art/custard-inspect.png" alt="Custard Inspect"></div> <div class="cv-logo-item cv-logo-placeholder"><img src="/devdocs/images/logo-art/custard-placeholder.png" alt="Custard Placeholder"></div> <div class="cv-logo-item"><img src="/devdocs/images/logo-art/custard-share.png" alt="Custard Share"></div></div> <br></div> <div class="scroll-top-button fa-lg d-print-none" style="display:none;bottom:2%;right:2%;position:fixed;" aria-hidden="true"><!--[--><i class="fas fa-arrow-circle-up"></i><!--]--></div></div> <div><footer><div class="text-center"><small>[Generated by <a href="https://markbind.org/">MarkBind 7.1.1</a> on Wed, 1 Jul 2026, 22:09:30 GMT+8]</small><br></div></footer></div><!--]--></div>
</body><style>
.cv-browser-triple {
border: 1px solid rgba(196,133,58,0.4);
border-radius: 10px;
overflow: hidden;
margin: 1rem 0;
font-size: 0.9rem;
}
.cv-browser-triple-bar {
background: rgba(129,76,32,0.2);
border-bottom: 1px solid rgba(196,133,58,0.35);
padding: 0.5rem 0.75rem;
display: flex;
align-items: center;
gap: 0.6rem;
}
.cv-browser-triple-dots {
display: flex;
gap: 5px;
flex-shrink: 0;
}
.cv-browser-triple-dot {
width: 10px;
height: 10px;
border-radius: 50%;
background: rgba(196,133,58,0.3);
}
.cv-browser-triple-url {
background: var(--bs-body-bg, #ffffff);
border: 1px solid rgba(196,133,58,0.2);
border-radius: 4px;
padding: 2px 10px;
font-size: 0.72rem;
color: var(--bs-body-color);
opacity: 0.8;
flex: 1;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
.cv-browser-triple-panes {
display: flex;
background: rgba(129,76,32,0.1);
gap: 6px;
padding: 6px;
align-items: stretch;
}
.cv-browser-triple-col {
flex: 1;
min-width: 0;
display: flex;
flex-direction: column;
}
.cv-browser-triple-pane {
padding: 1rem 1.25rem;
font-size: 0.85rem;
background: var(--bs-body-bg, #ffffff);
border-radius: 6px;
border: 1px solid rgba(196,133,58,0.15);
flex: 1;
}
.cv-browser-triple-menu {
display: flex;
flex-direction: column;
gap: 3px;
flex-shrink: 0;
width: 40px;
align-items: flex-end;
justify-content: center;
opacity: 0.4;
padding-right: 4px;
}
.cv-browser-triple-menu-dot {
width: 3px;
height: 3px;
border-radius: 50%;
background: var(--custard-light-brown);
}
</style>
<style>
.cv-browser-split {
border: 1px solid rgba(196,133,58,0.4);
border-radius: 10px;
overflow: hidden;
margin: 1rem 0;
font-size: 0.9rem;
}
.cv-browser-split-bar {
background: rgba(129,76,32,0.2);
border-bottom: 1px solid rgba(129,76,32,0.35);
padding: 0.5rem 0.75rem;
display: flex;
align-items: center;
gap: 0.6rem;
}
.cv-browser-split-dots {
display: flex;
gap: 5px;
flex-shrink: 0;
}
.cv-browser-split-dot {
width: 10px;
height: 10px;
border-radius: 50%;
background: rgba(196,133,58,0.3);
}
.cv-browser-split-urls {
display: flex;
flex: 1;
align-items: center;
gap: 0.6rem;
}
.cv-browser-split-url-divider {
width: 1px;
height: 14px;
background: rgba(196,133,58,0.4);
flex-shrink: 0;
}
.cv-browser-split-url {
background: var(--bs-body-bg, #ffffff);
border: 1px solid rgba(129,76,32,0.2);
border-radius: 4px;
padding: 2px 10px;
font-size: 0.72rem;
color: var(--bs-body-color);
opacity: 0.8;
flex: 1;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
.cv-browser-split-menu {
display: flex;
flex-direction: column;
gap: 3px;
flex-shrink: 0;
width: 40px;
align-items: flex-end;
justify-content: center;
opacity: 0.4;
padding-right: 4px;
}
.cv-browser-split-menu-dot {
width: 3px;
height: 3px;
border-radius: 50%;
background: var(--custard-light-brown);
}
.cv-browser-split-panes {
display: flex;
background: rgba(129,76,32,0.1);
gap: 6px;
padding: 6px;
}
.cv-browser-split-pane {
padding: 1.25rem 1.5rem;
font-size: 0.9rem;
background: var(--bs-body-bg, #ffffff);
flex: 1;
min-width: 0;
border-radius: 6px;
border: 1px solid rgba(129,76,32,0.2);
}
</style>
<style>
.cv-browser-single {
border: 1px solid rgba(196,133,58,0.4);
border-radius: 10px;
overflow: hidden;
margin: 1rem 0;
font-size: 0.9rem;
}
.cv-browser-single-bar {
background: rgba(129,76,32,0.2);
border-bottom: 1px solid rgba(196,133,58,0.35);
padding: 0.5rem 0.75rem;
display: flex;
align-items: center;
gap: 0.6rem;
}
.cv-browser-single-dots {
display: flex;
gap: 5px;
flex-shrink: 0;
}
.cv-browser-single-dot {
width: 10px;
height: 10px;
border-radius: 50%;
background: rgba(196,133,58,0.3);
}
.cv-browser-single-url {
background: var(--bs-body-bg, #ffffff);
border: 1px solid rgba(196,133,58,0.2);
border-radius: 4px;
padding: 2px 10px;
font-size: 0.72rem;
color: var(--bs-body-color);
opacity: 0.8;
flex: 1;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
.cv-browser-single-body {
background: var(--bs-body-bg, #ffffff);
padding: 1.25rem 1.5rem;
}
.cv-browser-triple-menu {
display: flex;
flex-direction: column;
gap: 3px;
flex-shrink: 0;
width: 40px;
align-items: flex-end;
justify-content: center;
opacity: 0.4;
padding-right: 4px;
}
.cv-browser-triple-menu-dot {
width: 3px;
height: 3px;
border-radius: 50%;
background: var(--custard-light-brown);
}
</style>
<style>
.cv-browser-split {
border: 1px solid rgba(196,133,58,0.4);
border-radius: 10px;
overflow: hidden;
margin: 1rem 0;
font-size: 0.9rem;
}
.cv-browser-split-bar {
background: rgba(129,76,32,0.2);
border-bottom: 1px solid rgba(129,76,32,0.35);
padding: 0.5rem 0.75rem;
display: flex;
align-items: center;
gap: 0.6rem;
}
.cv-browser-split-dots {
display: flex;
gap: 5px;
flex-shrink: 0;
}
.cv-browser-split-dot {
width: 10px;
height: 10px;
border-radius: 50%;
background: rgba(196,133,58,0.3);
}
.cv-browser-split-urls {
display: flex;
flex: 1;
align-items: center;
gap: 0.6rem;
}
.cv-browser-split-url-divider {
width: 1px;
height: 14px;
background: rgba(196,133,58,0.4);
flex-shrink: 0;
}
.cv-browser-split-url {
background: var(--bs-body-bg, #ffffff);
border: 1px solid rgba(129,76,32,0.2);
border-radius: 4px;
padding: 2px 10px;
font-size: 0.72rem;
color: var(--bs-body-color);
opacity: 0.8;
flex: 1;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
.cv-browser-split-menu {
display: flex;
flex-direction: column;
gap: 3px;
flex-shrink: 0;
width: 40px;
align-items: flex-end;
justify-content: center;
opacity: 0.4;
padding-right: 4px;
}
.cv-browser-split-menu-dot {
width: 3px;
height: 3px;
border-radius: 50%;
background: var(--custard-light-brown);
}
.cv-browser-split-panes {