From a006f2aeb6b3e6089d8c343d9e08fa217f45a965 Mon Sep 17 00:00:00 2001 From: Kevin Ge Date: Mon, 28 Aug 2023 12:25:08 -0500 Subject: [PATCH 1/2] improve HTMl, CSS, JS docs --- docs/frontend/css.md | 11 ++--------- docs/frontend/html-tag.png | Bin 0 -> 8330 bytes docs/frontend/html.md | 27 ++++++++++++++++++++------- docs/frontend/javascript.md | 14 +++++--------- 4 files changed, 27 insertions(+), 25 deletions(-) create mode 100644 docs/frontend/html-tag.png diff --git a/docs/frontend/css.md b/docs/frontend/css.md index 3cc105f..88fdf31 100644 --- a/docs/frontend/css.md +++ b/docs/frontend/css.md @@ -22,6 +22,8 @@ This block of code would turn all of the level 1 headings in the associated HTML - `color:` is the **property** - the thing we are trying to format. Other examples of properties include `font-size` or `margin`. - `red;` is the value of the property - specifically what we are setting the property to be. +For a good general overview of CSS, check out [CSS in 100 Seconds by Fireship](https://www.youtube.com/watch?v=OEV8gMkCHXQ&pp=ygUSY3NzIGluIDEwMCBzZWNvbmRz). + ## Ways to add CSS to Your HTML Document There are 3 ways to add CSS to an HTML doc: @@ -126,12 +128,3 @@ For further layout options, check out CSS Grid and CSS Flexbox. Here are some re - Grid: [https://css-tricks.com/snippets/css/a-guide-to-flexbox/](https://css-tricks.com/snippets/css/a-guide-to-flexbox/) - Flexbox: [https://css-tricks.com/snippets/css/complete-guide-grid/](https://css-tricks.com/snippets/css/complete-guide-grid/) - -## Frameworks - -It can be a tedious and time-consuming process to build up a presentable page starting from scratch with CSS. **Frameworks**, which are essentially CSS libraries, make it much easier. Here are some of the more popular Frameworks to get you started: - -- [Material UI](https://mui.com/) -- [Bootstrap](https://getbootstrap.com/) -- [Tailwind CSS](http://tailwindcss.com) -- [Bulma](http://bulma.io) diff --git a/docs/frontend/html-tag.png b/docs/frontend/html-tag.png new file mode 100644 index 0000000000000000000000000000000000000000..cdb49d28602659572dd9652b348403ae3b8724a9 GIT binary patch literal 8330 zcmc(EWmptY)94ZsN{S#N;?hbkvC>^j*V0`JEZyC(f|Sy&G%UU3k|Gk)wZsZYgObvq zz~}qk=l=Nq-amJK%$YN1;+Zq^JZH{1aatNmqz~yH0ssI~Wr(~E0DuSnN8c0S{RdYP zeEnE_-`blgY1jw&9;AUuoooTL*fLH*5F|qw&(!iL6 zZ7g=A4c!U^N)Iezv17=XgdZv~sEDMqn5IeWLRVRN#bRGBkk48d2$TW>bp(MiNk^UY zSU3MsAW*m5TQ>6TLf_Y~v*^UJ+F&4~sg|y8%)1dgi`YCnP}wjxw{Om?q+iCb(ia5u zMI5_^?f4;wwXNGa>a(q^tEI}8j?X~$Ci#2`U4st92Do20Gb9O|Wbq~*4dCi2^Pv|@JMFf{P!7>Ep z-!VytGRb%Wf#3{tpsx&YaBQ}zbHFC+b7^xY5c(cunNXD<$H?a`D9-$1TXkH z(u+>5YDvng0C|>+s-=f|z0XYu0y6mz6nP1Y8n(vi0vWY{Zy=^pKrlPdi52LRc=oi1O;V5z;Vpt!pvwz$532VA9lK%S+QP9r?{y+#m_dRI@QlW z!_LCY+)zbUU7Al61e}?fjgD%qt1eUXOSkon11iUvIQmJ+!?RpuyiKIz%>~_E%GuXH$6K$Eash@iAP?jA&-C@OjW=f1XOljs_2`=P7Qc_ zHwWZ2Iw#l4>y@f%APh9zJgsfw+_jY0ff6>eO#?FngCjuU+%(TPpl&oG)Gt)oFfidP z!q3wg>SnHGnrvXul$8%uwzdXIzuLA<2LN6~E6dA3{jvLb2eo-X3PeDv6@ZFJ=63Mb z!XEQr$5QpO_~YW%^;C0gg3GoM!5KZ6mV_Xx*An!F~ZUyyKjP&srYm2})Mr zH4-#zPgsRpFj$XMN{=>b_ox9n=|~u0xFF6oH$#DY6u3&EzxJ2G6ri$q)r!dSoXV*z zJ%CIF6ql{*NNk)rp>^YGAMFS;Kkv=lUIldVrQ?7tcxHmsLM#JwDeAwDF0T8HQrXU^ zS_oGYe1rgsewm~)kvSm8{g+~^u$IyXAXE+!VYltg3J?;RKKIzxw<1$nO~$W8#6D{g zH~xm5t1pM#?!jC)m_eEa*U}A3OBn8OpK9W?Z+j^~8LmqhBnKM@FnLipIUJ!qSUT{Q zzNm`x=Hl#SCrkhB(+d=JEq}b;gB^_jXC@|mvKjUuk7tDFIo-Du@)~e>KDmME!DAe= z{lcTjcewP(q)Ls@!i5>-;dnOPE;Fy$U@MqLqVvp6v)%NcLKy7zeG}PMW7;PtQXp%I zq(hH;@N1@0Iz3rPP(tEwWPb;xmEHuMjg@+bIh!zR)7)-Ll_Y2RgDlZGXo=X-1-ORIw3x=I47EkcUdL1<7oj z9C6^PIh2- zR8-=p({MIEv#4Q2D=iDd!-|Ts;NHaN45itlE(s!Ywm^+`a{_5g?61IAe}f`5@^+I`cEI5$_gm$4Ww1$d%E3k@SJKj0B1R1@#+8*@%II& zGFRHgp9SD|+N-rly83ofOMcgdl7bclZ*CL=qfJqb(3~x0jXmjVcaZ+G4+UHtIKNEfzMMpY z2foxQW(WKclyD-!0ZxoI-_5it2}LMHTqJ=g)P){(JrM_GrcL=(X9K)`FDsdu<^n2)4BBl4@BI{(GV zANQ?_xOeVTfC`&ep0wrrsR3jBsLhnWm^Z`GfJ7n6@UQe^mhD6Qf{#8CCA zbuv%$xVnm_vtjkVQQ$qx|J&#gQ33vsn%J@%XOker&vB>Y#s6Q{!tU z+fQ$n8V0UJG4g_7JrTl%Q=$N!Q|?`Fo>lI^@0w(&A)>=h6Vj5wDTl(DF<5 z;S-2n!aUr*^YJlG^x>cV)VVdRKt%^F;Zv4IE1q)Jr8nlfyn(u!hHWbg(%T1Lz;aEK z($T7l4_ZD4`ZlX#19`}JjT&(?eE-6sa@G28QGz54wZ^Ft5V4U3e+Kd48@)7qhjWT& zwMN^1X`>W0%yE)b56wxcI$?<^IL@5XxT~*Rm$x^Da3lfkwJjVT`$QxRQPPw8=}RasFPXp?TY(CnIY5l-Ty0j^W-I@ys($K}PZF4DiwdEv>j|;g}~$9RqWp zMv5!{*B4)Nek8bXvz=4S7-*9W96h}nSXr(SCW?}wbp^)h#11J=bl&eR!Fo{)U|E?T zRt20{QP-fbraAj8xrMnj9kcC_zLojbhS`=0UYp$J`10+xri3nCFH_?{c=h~~KG#vX zFwLF%+`SC~U9T$#u6$iD;fKE;j@?LjU3aWYEoOi0?59-?iub&pZ6ciO>p4BG{1b1q zQmOcn!0@f_(4Pl>SvlZnwAp1zXAIT%>KX|hm4gpD9lR&s8bhAsC?)Tem$4q)D*Vi1 z=t8h|Qs4I_FZ;m@_~wq3Uci%hM*?gA&a{8cG`&U49EyXn+Un0M-hHYlBZVqxL1ze% zOs|lRczTpiFijCiqIYntv>v_!*yR&PWKqr=Eozzn|KhiHAIV&4@vVXHYMtWJaHmy8 zOQj!5LxNU8Z;q$|=8lq$;2i5>-RzpFC(rYTof&njm7>KFKlu^*tj~SzCXO_&79Xt_ zRStIt$ykD^LoOrdp;TutR!Uqe2rdj}Hl8A_Op=wW5L3`%I$VQdI)rv2oX9j0POAt; zGP;A2Rh|u`kjA@2rr7l>TQb>C6gsl*yXS3A9=wN#humcS%lYg7 zh$oMDdUc4%)(D9n%gPe{rS4qJ{h5j8-@j;M;Qq;8g8ts|J>bv9pXE!K@3-|@^t4ue z6NN7Q5c?aJ4kMZ(k{$6P@sR<@6~?ce)#FaeM?J)KDn=R6v>K_RZg>?JYBZfGfkT8Q+$?+po}!3wf&PrCXHsPaURv(V&_AG0t7Ic`PeRmtJE+! z9SMri3ktp;2KPUl8B#F3sZ{Mbwe@o#_;Ns(mUEX4GpABn%`sdoN_;|UoZ&T=($>~? z+hO>I;LA~trouPD%%%GVCr{k~ZEj=o!2EO5RP_b-irt1+;Gb-#xd_wZW{2|t{c7-{ zE&pM>j;;@2#M-&XV?&XryteX#e3-EbDOPy=QiC|%sbE_TG8B;YVBIWK!)1Pv#Z)&t zhQe(eS8%p)vXolM_Ua2d+G|IS!cS?R4WHRX6C(Wa=F4q|gqbDdR!qFVla?LK%H)T+ z-g3sF@#Cipl`A|lx#Jvi)TVW(S!TL{iX=PQaK2yO20wH3oi3D=KDrKv`>C6Hdv`V} z{M?IAa*yvS|H!w$_A4h@viX*#?<-3VWc}+e2PqGsY`oe{r&l7kc@I3n%49y?=L0WB zlgQ#Plm=M^2)4P3Kn0-w%jQRI{oRR&;jiS43j~fLUYk--_H5LlF0ZnvTi^Pg9((o$ zYdR|yP0nk5aoxyx-em%hF-%1y+RpFNW&JNW60 zRsXfea%ri>YJ2UL1y0w${`(=b#Gtm$#_ZjjF{nQiHowgHv{ZP9R6f4t?Kq|tI-f>W z?n;6;KP=jne!7ac15~J)?4sNu|N8U`Q&v)=KIseAxye=e6ukN{@932MfQGS@h#OfJIzis zt)|7$#_R~aJld^Y%BMULMU0+WCIxZ)y=a0NRMVx?VfxnRsbaj4HmOJNa?H{>;`DjX zmzOnk>n9Rs6d#EO1&AESR;i_pL9!^;RZ;y(T;pMK%;0!@_tfjo?+)Z7i`;2%8Gd|H zQO{Vjodcm76v}a8lUwxM7CkGLl8#sR0rSx3YmFKjW*#mzMjEX7Y9$%O?vzZ=7IP7Q z7EPEuWROLLM4CzRSl6j>7x%zNCG!&w5qQZi*Gmj(zE$%Qp_!S zZZuX=7NE##s@D^=4Y$(V5Z|1vCwZA;Vhmd{0n){5FpXm#cCzHR+=3f{DdZ*=?cGC4 zTjL~O8Bw1MUvV-lWqXdm1xA?2Z%#s-gTn?|OeGYlfwB9Anw#K)*i+RlQpGn(wtI9F z>f6hGcC8}jD|x9>MYrtnM=y3>u_K0Dng~VJ6h*8Q_2_J~d#hj42s6R06woO+CVOv1 zPOZb8vM@z1k4cRg+X#M6r~IrQjOG5KV~^jUf?8Jg3%p-hfo+K_u)_!TwvfMzcSbYx zt`ebnom`D^c2iB09meZd+og_3j>?-x7LQPhMY*NY!K*zxp(JA)`fqb!rf6$8%zDiG zrqX%Cep%a@D1h*8J9V9+mKDbcD9ShS%6 zr;S!hyi7dFTrzQIH~B``0x!_tPEV;95>_bF=~lOwE1)T0>jX);c+^S+xCP^+w{B8y1=*D!X62;(7U)?cqEqntuTT;Z8euy6~^#HI~uzufO#iTc;Iy39XI56F;5&{ymd|<0#Bk zfuTdZxvqWNjk)mi+u6SHz3yl)=MWmWX55DjO!xzPeo8I`f zy^vmXnWyo*ykoig-9OJpL8~lx@!>TbV<-|ZwJoEZ4@tt&Cz_XsQ;}#-QKdr8c`akR z-Z|4ovia^9GSwkx)23-AH-)HajO-DeTCKyW=EeA5yMb5lHXy?p)!)c3)GpFO68D|7 zf3c#TFtRenyyucKRDmqczxoR_@l}XT3sJUJz9aD~KyL{6dFK7`KLWM=urROt$FLti zyb|=$Hyo~}hsY1qA`P-;qWK6? z@-Hm4rU6gb^{&|pW5VOR9`;v4n;T>o9c(`=;}+-SC=4Y)+qeQJEWjIxbRBSQ>*epc z$SvH<5*nQRbbf9*n{@8T4Tv6!T(2WWF8GZ3L2Kd8T)Pi%wJ%f-ntT4{Lv71kYiH=P3K9fD>(LX!e8oBtkVJ}6^T^`#U?Mcg47 zpZ>f4juAe}*jw^4!4Dr*iO47=*peQ2CHml|(<8}o;<=YwsApBkUud8F_nQ!2*N=#Y zhn?}~2dN4li=+qGCLJiD;DnMYMCQ2AlSpm+{5$0JgQEs|uZ3ncJ<^M2X}LS33`M-K z6g77y+CIHih?7}p^u5vRNz|l&71TpR-fvFc~2Ba@hQiWOn+4c-NWBl;X z|Bax?uVY%VYc1%p(+0^Lf2;p4CZzwQx+FNY#k`TkMH>;q*E?waq}=gfn-FLHn8 zr)Ary^%=TyeCR#!nWyF{zhD?tTi(jC_hX?~^1;3{cZ3R9^2gJE14xamnR~w``js!GHhDkQ{dVT4Nm^T7>22r_c!qQ{dfG0LCxjI=GFw)xq|EJojB)mA{(!d zWRq&|VV@6OkC%V2v?XuyIzpw(m}=)qQ#4TnX(< zwDqdC$v&W8TB-lN>@$eMd%rYVFfZ8F*_`PDwRH}ZzD#~o5sG1!Hk)UTH?3OVW*{z; zytza3=L!W2FS+m0wUtNKstW-d?E(iiL%PGl_OP3oW$p0kpk(v$D5sxWX-Z7^;32hJ z_aA3Br8|mrFD_z(#(}5vkzP1l(341VkR^LoxRN!PCSBX#@4ZBTA;oK_@{>y~;)eYb6w~?6!TY ziO3&?%6s4JwwvFT9yHVrCn7Z-q#rxI=jZa z9j?%^MG#(~L6#-^^5K`E{eCWz8ci9o%pTTJ8yqRm9ga!^0`AJ*G#`b-`7IvRnwS!g zI8q+l*cmYzuwQn)2%3Ew0<)nSiq@1xobYX%^Db!={Op(O;2LE{bCGqz_Hj*(TL+x| z{*F|c9V1#>d0uCsLb{XQ%6UFk(uvR*khE0ywl3}T6T5tc-gus)rCprZbiy54b9zgV zv!@=N-cxCIdIZW4*gBe*2-Q;l=X=t~$b4v?r#g@S@A$Dv;f2xn>HSBRi(5fHyd<4k z#R3UqQ)o;~`_mT9Ivvmb?qEO5s)!mM=Qf&OFY1u@nCMk^6c$5>}X}%f5I|MBLl?77hrR19rk~M~dM(NW|NWkEUj< zvhu(qZEqJDzL!L`bQn+nlOtr=%eVwfq)0d8_QaFuvlT|&ZJ0-1o%O?H*rHYYuMD|V z6%;DCVa8GsglT%==H8+b9XYvD<#QdH7<36w%W`N=2;lY^DO6@Px+Y(9yDInhBL9DzDm!X}*Ps8nKoxUP#Avta>lmakMUNz0hK(0T zKTe*G%r7v!`|;`d!^_e1X`rVXrh-lz{O=s7$dSbi86me77l%aNDa!v}*mOfr;Vvva zrxfXBb+raDdD;RX#g`&7Z``u@jz0%^kzv} z-MLX@+}AzKd#k?z(m$L^2wqHyKm6_ceISC{?FzNsE2U^zxX8csObe_-ULRyKW~qNl z)7!?=?8oY&8X&Q6h5gS;au*y%v@L>buRlSl_8kMb_K?Ov^e&J;ch#m`DYHH@4^4JZ zFL-KWAn8oYdnp@GdddzwwllRKt?Ih#}?96vc|nyAut zrkif^D8H0I9Y5tLfA4k)joSP^a{sLT*ap8ZLj^)HxPo?6>!hEgn$wB0Tx`>s<^aQ_ zB2nr_s^7|l=_UsSE5mb{<6XIel#)i!kYV9!UuwKJMcy0fup-@G3vPmWMe1{&E5P zqhm*)*RpS(T;#XHEj@n-1#oPBq8n;(!)Rs0frH(8a(2iF`ak-l>6HYY`zBy$+5cW7 z)WgG65=kws?Ji_i+J$RZ!iE*)oYP17!%#oym8Y9w~`KgCjDc0j?1;-}z$J zBZzx_^eCr%<3LmF61DM)MBb_`Y4b!KmytwlujzdQt6`skZa9X{s0DpO zZ`1?Z^V$5VKri2!h89Co35BX05`RA8D0Sx%SNTCQnDphaXl@0qz8v{aS?bBwq6h>9KHo?SR!Fe0Na;sqA{mi)mZ_3g7M3Kx&J$*D8|zvugOS zi_em(gyHg66&_6@%Ltd)F;6}>(%q2Nz*%r^WWYGF5tvB>2YmrtzVGHlnV2E`k{tCP z)n#~B0ru@;gjdMF)bfO%IFbEgyFOq>91l9Zo!5m%>NtlJ$6_u9RC6@N6cTf9e{_%_u@+{1b)Jv^Q=t<8 literal 0 HcmV?d00001 diff --git a/docs/frontend/html.md b/docs/frontend/html.md index 6bd2d72..cfd5d55 100644 --- a/docs/frontend/html.md +++ b/docs/frontend/html.md @@ -6,14 +6,27 @@ sidebar_position: 1 HTML (HyperText Markup Language) is the code that is used to structure a web page and its content. For example, content could be structured within a set of paragraphs, a list of bulleted points, or using images and data tables. -## Learning Resources +## The Anatomy of HTML -### Videos +HTML is made up of a bunch of tags. This is a tag: -- [HTML in 100 Seconds](https://www.youtube.com/watch?v=ok-plXXHlWw) -- [Learn HTML in 1 hour 🌎](https://www.youtube.com/watch?v=HD13eq_Pmp8) +![](./html-tag.png) -### Articles +You can nest tags inside each other and put them next to each other. Tags are displayed from left to right and top to bottom. -- [Getting started with HTML - MDN](https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Getting_started) -- [HTML Basics for Beginners - FreeCodeCamp](https://www.freecodecamp.org/news/html-basics-for-beginners) +For example: + +```HTML +

This is a Heading

+

This is a paragraph.

+This is a bolded link. +``` + +

This is a Heading

+

This is a paragraph.

+This is a bolded link. + +
+
+ +To learn more about the basic structure and various tags of HTML, [check out "HTML in 100 seconds" by Fireship](https://www.youtube.com/watch?v=ok-plXXHlWw). When you're done with that, [watch "HTML Basics for Beginners" by FreeCodeCamp](https://www.youtube.com/watch?v=pMJ0NI3OkYA). diff --git a/docs/frontend/javascript.md b/docs/frontend/javascript.md index 2b44863..3e56434 100644 --- a/docs/frontend/javascript.md +++ b/docs/frontend/javascript.md @@ -8,6 +8,10 @@ JavaScript is the language that is used on the web. All sites today have some so JavaScript, you will find, is a much more dynamic language and allows you to do a lot of things that other programming languages don't like. However, this freedom comes with a downside: JavaScript tends to produce a ton more runtime errors due to its lack of compilation and type checking. You might hear many online hate on JavaScript (and with good reason), but it is the basis for the modern web. And once you learn the basics, you can explore more typed-variations such as TypeScript and CoffeeScript. +For a good general overview of Javascript, check out [JavaScript in 100 Seconds by Fireship](https://www.youtube.com/watch?v=DHjqpvDnNGE). + +For a more in-depth introduction to the language, watch [JavaScript Crash Course for Begineers](https://www.youtube.com/watch?v=hdI2bqOjy3c). + ## Where to Write JavaScript? JavaScript can be placed in primarily 2 places: @@ -49,15 +53,7 @@ window.onload = function () { }; ``` -## Variables - -JavaScript is not strictly typed, so it only has 3 main variable definitions: - -- `var`: Declares a variable (uses hoisting, which allows use before decleration) -- `let`: Also declares a variable but enforces that declerations should be before use -- `const`: Same as constant variables in other languages, cannot be changed after it is defined - -## External Links +## More Resources - [The Modern JavaScript Tutorial](https://javascript.info/) - [W3 Schools JavaScript Tutorial](https://www.w3schools.com/js/) From 78f7e6bf762a97e175c920ac355435c1945c03ba Mon Sep 17 00:00:00 2001 From: Kevin Ge Date: Mon, 28 Aug 2023 12:52:07 -0500 Subject: [PATCH 2/2] move 'A hacker's guide to hackathons, made by the HackUTD Team.' --- docusaurus.config.js | 3 ++- src/pages/index.tsx | 11 ++++++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 3335e79..e78ec0d 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -7,7 +7,8 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); /** @type {import('@docusaurus/types').Config} */ const config = { title: 'HackUTD Tech Guide', - tagline: 'Your one-stop shop for all tech resources during HackUTD!', + tagline: + "A hacker's guide to hackathons, made by the HackUTD Team. Your one-stop shop for all tech resources during HackUTD!", url: 'https://guide.hackutd.co', baseUrl: '/', onBrokenLinks: 'throw', diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 2b55e4b..0ee2665 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -13,7 +13,16 @@ function HomepageHeader() {

{siteConfig.title}

-

{siteConfig.tagline}

+

+ {siteConfig.tagline} +