From ec27cd9f29a3f1fb1bf5fc2c2fdc5e07a0aa2acd Mon Sep 17 00:00:00 2001
From: Liam <liam@fascinated.cc>
Date: Sun, 21 Apr 2024 17:39:00 +0100
Subject: [PATCH] add github icon and display breadcrumb on docs home page

---
 public/media/github.png                   | Bin 0 -> 5325 bytes
 src/app/(pages)/docs/[[...slug]]/page.tsx |  41 +++++++++++++---------
 src/app/(pages)/docs/layout.tsx           |   3 +-
 src/app/components/docs/github-link.tsx   |  22 ++++++++++++
 src/app/components/docs/sidebar.tsx       |  10 ++++++
 5 files changed, 58 insertions(+), 18 deletions(-)
 create mode 100644 public/media/github.png
 create mode 100644 src/app/components/docs/github-link.tsx
 create mode 100644 src/app/components/docs/sidebar.tsx

diff --git a/public/media/github.png b/public/media/github.png
new file mode 100644
index 0000000000000000000000000000000000000000..c61095c7d6b673a71d42e758934d04ab91c2f09e
GIT binary patch
literal 5325
zcmeI0_dgU4z{ibjXJzM9_8BEBTlP%G(Gjwpy$+X|bvWtDIy+~aJG-(s7a`-6y>~)f
zqKxo-pTFaIKCjp3m-la<_m7_xGgEy4Juf{O85zLPK*xfNj9l`+3ei&jM@mTl#L37g
zF3n89y7~bo|B?UC{~P!}Xh2$RujRkl*DwoHOEMbPyAL!>9Q-1ZG774i8fr3=qx~IC
zHDv_ZXo0HF!}D9lHjXc^Pd15dMUhVGcj#_;rFYJqE_S2&i^qTc{#q8S#i<|H{(Z04
zT)AVP6#s~k_bFy+9e3OF<6(dZxAR|b28*LwmizLM)(hs@l?35z#mavM#zyb8#j0gF
zQqK82egshyMh&w{pRMgmxr=VQV%g>9!{`U6Y{?f6z-BJXeR$Lh&^<Lv-#69*t1-}u
zKjJTEZcKiLMdiAE;?X_pQIOUXs^_{n-7iViJOHqN>tmyXDEaX2iyaf3lEUisa91eu
zNzPBD)W<vDMj9sq6U&FvB(_2dAJ(bly^6Kzv4N72vAi_Y(FDWE_j}`=UCi03i1rIj
zVZIAZKSg*JntY@7|MhVHE&Bbn@lHId?p@3yN3#F}C<G4IaRq~2VQ{#Kk6omevqg}R
z7w;c(^&dRBHgig?FV3j`b@i33r+@u$gd7%!<9CsH^KIu^R|v!ac6+sq6P`8s>U6p(
z^a}HOtoESD0Up2Hbrq|5)reV}ee0!YGX<TSRlLqkSsTK8Dt;Z=UsSzrP3%t)R(!Q`
zG%S9d@jA9KL~&ri-IeCLs;2Fyuwu{H!MY+~Hh8oRlP?-tG{8Q^|I*fqh8c*pd7Q6b
zJYg|sZX2+FN(bGD3ChZ5A1jO#A+H!GVsRgd0wCmcT46l3nmIe>hiaKhNUZaueS#}`
zTWoks;?3@EV<dg><t88*CX1q2YKx*-2QQYJ{XNjmUZ!E+cM`tw;y9;7%?7~^LW7oj
zER#t-$@Ke6h$yKEu=A>tWPX&Uyof^|w$Q!uXji`a#Wy{-Ws%-=k3?|AD$oah+cZlc
z(rNKGGkAA{gFEzqZfgGGM(H#?Zcb?AEHZt#voh{(mpS<G0KmN#hGHW1Q&QHdVg)0m
z4r@0`6=#}bpFdb!l5b64XUdZE4WOfm>w?5jX%YK9-y+%`z3sULI^ez2(vA%`prs2k
z0^r)CqHkBu)wj$3-5)s^BVDS5*Qot<2?Gl;a^;$&CL6}~E_-S2K`6AhnkS6tdmf#5
ziZ_*i$wt}y`ud?3<}S==`7$g*3_8^_<vm^NJ%7M)o<941#vd+79y8mLGUkKO945v#
zlbR1WntXtU@7~P2Eh%hTWSjaX-QE5g3-lb6y1O%1c-&;)u1|27XHssYp%ydN4;8Fy
z@Qd)6h$uO@o!VYg8cbQ--Ut(Fpyz|TuSAFI>*P`fZ026U{1{-NBo-iuT2us;Z;Db`
z6y!HO#xOk5e5&8~gQ%_;(lAIk#;t!|wPS7zzyV;eNG71sPX;dP17A&)k~v3h0b>Qj
z+PC6-%ZeYfJT0Mrgv0el4a6XNPrV){n2v>DZjNgiPW_f!P7E>wC*NB_GexNycpPck
z3_J5m9Qfj-Giy1XB=FOJ&0U4!q|0DpX&H9+fnGkT<=%TIw;kv3R3T%3N+mA!mmfx0
zjECvfM22lgfIx?6R7dH*-pow2M_2n%eBX5^Tx2~fKsoz8>n>xiHkIsJ(?`P2q@Y=q
z5BH&Se%74-W$?8I)Cv|RW?<sqQTeZYNjP;1>Fk#(qTQ$qmhL29%xugVvr6)sKuM#C
z$u;OCzp5LpFRC797KOJ_9qx3i+}Z_Hq}M}RD#Yx$>0>MUPLo#M%7;%zV^zk|x`IyT
z376DbB_Iy_@mQ5B{ij6<I>(AKt<XlYoelCqaK#7aHH7?K*xd$tSNH4`#7u`Nhu<UF
z>vEW|53R|jS|t&4zrofNEfC}=@DQgb3vEEvjv{g!Fyd60p&ln#4flwvs@40nMCz1}
z_+lIfVcl6{P^v5)Zym|wCC)aEwUw-<1540qrFcN!*N2<c^k+5R$JuVGRq<L$+<1#1
z;C$FdT*<6dVC-z7xW15_p%~n<&!v9*jHAeH^VJYs_8T4f^mQizVKI`IH?A?aGSZGt
z<ijhrzuM&pX3MNuD``}NkkKp!W-K4<DKp~Y5QA)p7k`&vR{q(M|H-UaFr^nC*7jYW
zs)(7G0AN_X)QiiBpHi%m85zW1;$`^V<lzV#_nd*Xzc@6I4?BT$ZpYlYlB2S4<cxj@
zQV?aR%_{$7m7_bRxO+7@+^U<RE1mX2FeJw7q}X6rFK1wull>VD7n{H3wqcIG4N~eP
zK6nH4k;nZ=vj2$C8p_VY6r8Jrw@nEUkxpP6)$g(U_spUaP%u=ivtyn!+Q3a8#Uxsi
zWL_dUQbCu9^^bQ!gUl)2<qEX+)`+d!?58EHBRiXX!;2$vf@fkZZM@sZ?1|Ye*Ni~2
zkGuN0a{<Lh(o^kB-<0`HSQl=#ETF-MYa7yabvfwBqkjrh&uDLcp)VaA93J%MooeS`
zmW{}i*?2pXbabdtb>PH4^oZXx5d70KXVDJ{gY*4S$AlL;1ziEfWWX0yBvq3`ATko5
z@_ijQ{~%}CTft~#Sj$fzH_xRc-EGbOg1psNAp|4%5G~;HX5n5X$09eUG?ZI7{VS;s
zfj=+-+IAN(<zjuap!X!5=nT_NmS(^b@?_a8#5lGP5_9)k@ZK%RCwU{GcYQ0{mW@^Q
z$^IZ2)))!xsoEZa<q`uB;Nk}}Fi96|SpG@oU-^*)xN1uYqGNhPIQ{!jn3@LQ%W0m#
z;l>k`c_Wt-4+F@;tm|zUndAnd38<ZlvlWF5gx$@A@}N|<qfDlh2{NXmC7&=8Ev2$n
z`B&7Ef)BL5*c9c0r8?xRH$0J(1Yjb5{;y5_YZ{ORdzf8?m&&>muv{$Yxxh<3W4x^n
zQ}qT7^4K46XO+cDg_6NWEBA~{U~8*PzRb)$zIt}e2QqkL7)(Rz?c}v)af`k|{O$nQ
z6CH+;OJ6tuyd~X2MFdn*cBR_U1SD@<buIY5>@WUko_Y7;y0qP;VMItZhG>4n!trx!
z1bnCGD7oy>Aq?^vKyR-}PgNq`tGtXQD*Ip_L0ur9_t?Es)!37l-0?OvnDiE-l(G8P
zP3*hzw?PkBrzbMCLZl1WrW}DNGqIcUAamffd4|?#U_P6RBXHaj*C}0nv!1a#n?0Q4
zga1&18{>J7MT=od{*n_%l`|+&DKkf%%9_=%l&}tm=tgf4&e^QZ=TGZ*`^2w|OIKFU
z0M*V4{q>ngrPS8an;ghB1vlOvUg`mh%6K@j`_}Xulyk6Il8gp{m(!wJDH?0?^9H0(
z5$U$BPaj1gF=%7*UKyf^iK~x8CW$q1M2JnYTEEe1eE`+MOm@}3<jC|+1!T@sFbtO2
zk?UAgrpk|Hd{IlJ&r}9au&HEi2}}_6@VnBT_{lpgf_<Q=FU%rn`P85$nm0@7&QE$b
z9g3-ke)Lcw3uA|-%BfY@VgoZTsIb-`B(EKf88Rr!(aRXuA5Zqj{2o?d#7Co1jMh;`
zUX0@AMM7Q&jpGJv7<fLmACb2Cn#=&6$XoEz)AtpIlVCdRZ!LGt-;+KmB%pus@bg)3
z0fiQR2)y_{F)uSt$;~W(G}Hr<;N#+?_swV0UF<+{?p>ZFKgG>m17GKg!3f5jsCs!c
z?@8q=jekaIe|mi?BTdpo=59N`RXJub*;Z{7m-1If>qA}|&g^e7tv^X~z*w_pISOR>
zPFC(28fNH-W()VoDU6l4Ulj6*WW1P{^E_M8{}~+|1bvRPS2n>+gtR$PTv@k1T&nkG
zF}Z_bS|T>eU%f9lP>kYK_cu^!+i2@6Yj~6tNeYa2|0Z=ps@q7~Df&Y4eDY~R&4r^j
z9nBL>)>Wl1v-C}Zzx7|zLHL&JsaW^QPA%_XjqK82Z|~C*!PK3mTZ2FCjN9tM<WCC{
znxw=kh=^LyiJ6CF<d=EcT}O%ikkWfvGEKc<V6`Xq9W)Wq#(30ZXBXRy=rcTu=_+no
zT<d{`I^AJD{B8J|Z2)DF-QXGK7YR#w7_EI7iRfVKE-o_lzhZJ=i>dZw51CZaRNrbV
zKFu-jjv;xsAL7T3mFqOfP{uhO0<X_)QSDTph>2)y`PvhkrRW8n5X4EurJ^cS4|O}j
zJnUPU)U}sDb9Gn-&SE67>F|O;S@Ju}meZ6{k}Yh!k|Dxod>%Jnu#RqTL<F)G!P`lR
zuDq@cd?|;z73cms{BMmx6HYN}UK&<$V`K6TA6=u+%W`I5;j>1T=4XPa9YW@A{Z4t7
zc15E)O>=*<dS0F3(0bsS+<a=leyo{t^9I-E+SANDn3}z)%f+6*?tpgcUAM59Q}>TR
zd+i<8CQ&)xCe`Dt+xuIR6}RZmG*g53m?q-qJv;Nx<|Ai~3yf-fP?}X;{X0tUdhrAp
zXxo0aY7seK78-Y}sJvo-1Yx;_yF*|O6)(hce)I2<ivMx9j?h|gA6GnOIGdYp0$4`m
z|CtaBXO3k+<AemrLPgAK<rWoQ7Lhbs)@KTg!sQbR<1){AlxK}M8pq>|Pw>$1vIjs+
zjT*Busa==gi}3z6iihUj4vJ8HE#R-o)tx|e{J5>D86|$f8cJaalIBw$lD+~O549G8
z6}Unx%{w_Qi!-`<Cv!V;H#o!@iYQbL;aiCQHo3`mv$eR6XXd6{mFy9mZAw~#{r%dB
zcL0{oHC$$ec|>y&Km&PYX7Puo-+RZx%;Vm-JKX!G_@#KP2Q1!B9|5qy_Yo$D=2X1j
zZ>l|Or>5yyKIKL|f5*C#uJ?k)%k2dFA?(fP_pahz^!A-P@y95H*Aw%(dgvx=OODaB
z=2I%@8*&!KI($&LYJ6?f6&Y;m<-p)bY)_AwZv>gh7}gRmI-u<#8;938OWDo>hte^b
z@CWBHMcR4v1n%6cQA#5*xqk4socNs*AoSDcYQ;;hBRn~#o~rvp)%dVNykqh`xkq&e
zEc6AYx;IzBWB8Y)np^F<ukAUOfCG4A%2!FV?&9-Q{uhPk3k<FM-e1p$7^p473~h+3
zjojikW<1MTT1z3aK7%uy%TsCL7xcXLW$8IHt5zJikM^EKs2O*bE4DWuYf@3$#+2ax
z8HW?<_z@ehyQ>zz!2dIz3xF&sGU}7+#|!<Tf<Lk54r$ooTa>92&brb3-T+cZ-Se13
z3oir{=nz&(X`@r3ZMH8d`Eju-6*xJHCic>Rty@?-N|jD5DBE_l-EzBgRIA-RiMm_%
zV0Ved*%7CoIW&cQP(uzszjsda^$t;#ZAuHVUXgZXkxd{1eGNU3s@$UR+0*BWbRHj~
z<f~1IQ-E7jNM%`f()&``ws*!If;HynvB=mZWx&16Kx_gEA<v~;rI$-m>J;!>YU6l+
zr#k8yeC3JvN1O=5W)l3Kt!6m+CXrJU?MI^?RR5IzL?(eaA!n5733rO3A~4q5Lh_x8
zrKah<nHf+1++|3#qNcv^$+7A~)=(2JgEDOU&nzJJ8u2vM%8%2s&(BODji37jO&ux}
zR#2qedj3jU=9HK>c?oWs9!n9H8L3yK0yTBE>11iIKo0(p^6u&Sj&46VR77<@<^Blo
z^dL2<h1EY#w%U1ugwU^uP^&(kKN_Ah=G`ZSLbB#9%R-glkIT^=eAZdDnJo~i<zq<Z
zQ$pTdI*DUr_*~C#ce=ekIrvI&?=nMGU`(Z4)P>S%+(-FN>s!{0<;q;qadoFLK%Cz7
z0C6r%q4L3g5L2Z73L2+1!$X{Ff>Z`Lb3}eQUFhPq{tX~0{Tg37?yv7#z!JE0(FF&=
zhc;?7eNU~#G@ovlX?uKj*)b}-bNXS>9d@8_oNbmrX5T{o{Nb8(p$+rW;}Y5N=W#rn
z-g=+0nql5QAlv0WIiEf`!yJ{4(U+>gofb~_uV;JU?Lb*x>K(p5Rp%IW+K)W;IE7&E
z2>=3~8CpVLhu}Gzc|H)6z?4{2(D1bF^1v`>`o4?TZ|0S-_ySVEM3qL@J6g+Ifq1z1
zoR=VD!@cZRzJJaQA&-tnWTdU9q90Q@c3e|FT==R*tBP#?-#5xo*Houg%Q5bM0E@!I
A-2eap

literal 0
HcmV?d00001

diff --git a/src/app/(pages)/docs/[[...slug]]/page.tsx b/src/app/(pages)/docs/[[...slug]]/page.tsx
index 7cdf974..21e6bf8 100644
--- a/src/app/(pages)/docs/[[...slug]]/page.tsx
+++ b/src/app/(pages)/docs/[[...slug]]/page.tsx
@@ -12,6 +12,8 @@ import {
 } from "@/app/components/ui/breadcrumb";
 import { capitalizeFirstLetter } from "@/app/common/string-utils";
 import { notFound } from "next/navigation";
+import { GithubLink } from "@/app/components/docs/github-link";
+import { cn } from "@/app/common/utils";
 
 type DocumentationPageParams = {
   params: {
@@ -56,33 +58,38 @@ export default function Page({ params: { slug } }: DocumentationPageParams) {
   }
 
   const slugParts = page.slug.split("/");
+  const isHome = slugParts.length == 1;
 
   return (
     <div className="w-full h-full px-4 flex flex-col gap-4">
-      {slugParts.length > 1 && (
+      <div className="flex justify-between">
+        {/* The breadcrumb for the documentation page */}
         <Breadcrumb>
           <BreadcrumbList>
             <BreadcrumbItem>
-              <BreadcrumbLink href="/docs">Home</BreadcrumbLink>
+              <BreadcrumbLink href={`/docs`}>Home</BreadcrumbLink>
             </BreadcrumbItem>
-            {slugParts.map((slug, index, array) => {
-              const path: string = array.slice(0, index + 1).join("/");
-              const name: string = slug.includes("-")
-                ? slug.split("-").map(capitalizeFirstLetter).join(" ")
-                : capitalizeFirstLetter(slug);
+            {!isHome &&
+              slugParts.map((slug, index, array) => {
+                const path: string = array.slice(0, index + 1).join("/");
+                const name: string = slug.includes("-")
+                  ? slug.split("-").map(capitalizeFirstLetter).join(" ")
+                  : capitalizeFirstLetter(slug);
 
-              return (
-                <div key={slug} className="flex items-center ">
-                  <BreadcrumbSeparator className="pr-1.5" />
-                  <BreadcrumbItem>
-                    <BreadcrumbLink href={`/docs/${path}`}>{capitalizeFirstLetter(name)}</BreadcrumbLink>
-                  </BreadcrumbItem>
-                </div>
-              );
-            })}
+                return (
+                  <div key={slug} className="flex items-center ">
+                    <BreadcrumbSeparator className="pr-1.5" />
+                    <BreadcrumbItem>
+                      <BreadcrumbLink href={`/docs/${path}`}>{capitalizeFirstLetter(name)}</BreadcrumbLink>
+                    </BreadcrumbItem>
+                  </div>
+                );
+              })}
           </BreadcrumbList>
         </Breadcrumb>
-      )}
+
+        <GithubLink page={page} />
+      </div>
 
       {/* The documentation page title and description */}
       <div className="text-center mb-4">
diff --git a/src/app/(pages)/docs/layout.tsx b/src/app/(pages)/docs/layout.tsx
index c5d042b..90653f7 100644
--- a/src/app/(pages)/docs/layout.tsx
+++ b/src/app/(pages)/docs/layout.tsx
@@ -1,5 +1,6 @@
 import React, { ReactElement } from "react";
 import { Search } from "@/app/components/docs/search";
+import { Sidebar } from "@/app/components/docs/sidebar";
 
 export default function RootLayout({
   children,
@@ -8,7 +9,7 @@ export default function RootLayout({
 }>): ReactElement {
   return (
     <div className="w-full flex flex-col items-center gap-2 h-full md:flex-row md:items-start">
-      <Search />
+      <Sidebar />
       {children}
     </div>
   );
diff --git a/src/app/components/docs/github-link.tsx b/src/app/components/docs/github-link.tsx
new file mode 100644
index 0000000..78a7fb6
--- /dev/null
+++ b/src/app/components/docs/github-link.tsx
@@ -0,0 +1,22 @@
+import { DocsContentMetadata } from "@/app/common/documentation";
+import { ReactElement } from "react";
+import Image from "next/image";
+import Link from "next/link";
+
+type GithubLink = {
+  /**
+   * The page to link to.
+   */
+  page: DocsContentMetadata;
+};
+
+export function GithubLink({ page }: GithubLink): ReactElement {
+  return (
+    <Link
+      href={`https://git.fascinated.cc/MinecraftUtilities/Frontend/src/branch/master/documentation/${page.slug}.md`}
+      target="_blank"
+    >
+      <Image src="/media/github.png" alt="The GitHub logo" width={24} height={24} className="filter dark:invert" />
+    </Link>
+  );
+}
diff --git a/src/app/components/docs/sidebar.tsx b/src/app/components/docs/sidebar.tsx
new file mode 100644
index 0000000..aeb5f46
--- /dev/null
+++ b/src/app/components/docs/sidebar.tsx
@@ -0,0 +1,10 @@
+import { Search } from "@/app/components/docs/search";
+import { ReactElement } from "react";
+
+export function Sidebar(): ReactElement {
+  return (
+    <div className="flex flex-row gap-2 h-full md:flex-col">
+      <Search />
+    </div>
+  );
+}