From 949a3fc1b78ce82e129a1aa92fd5baba88507073 Mon Sep 17 00:00:00 2001 From: Hugues Verlin Date: Mon, 16 Dec 2024 20:56:06 +0100 Subject: [PATCH] docs: add getting-started carousel (#3613) * docs: add getting-started carousel * update * update * update --- docs/.vitepress/config.ts | 2 + docs/.vitepress/theme/index.ts | 11 +++- docs/bun.lockb | Bin 81900 -> 82351 bytes docs/getting-started.md | 106 ++++++++++++++++++++++++++++++--- docs/installing-mise.md | 18 ++++-- docs/package.json | 3 +- 6 files changed, 124 insertions(+), 16 deletions(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 593f06a001..b1ebfe8e57 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -4,6 +4,7 @@ import { groupIconMdPlugin, groupIconVitePlugin, } from "vitepress-plugin-group-icons"; +import { tabsMarkdownPlugin } from "vitepress-plugin-tabs"; // https://vitepress.dev/reference/site-config export default defineConfig({ @@ -179,6 +180,7 @@ export default defineConfig({ markdown: { config(md) { md.use(groupIconMdPlugin); + md.use(tabsMarkdownPlugin); }, }, vite: { diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts index 2a9a5d1096..0258e4c7f4 100644 --- a/docs/.vitepress/theme/index.ts +++ b/docs/.vitepress/theme/index.ts @@ -1,4 +1,11 @@ -import Theme from "vitepress/theme"; +import type { Theme } from "vitepress"; +import DefaultTheme from "vitepress/theme"; +import { enhanceAppWithTabs } from "vitepress-plugin-tabs/client"; import "virtual:group-icons.css"; -export default Theme; +export default { + extends: DefaultTheme, + enhanceApp({ app }) { + enhanceAppWithTabs(app); + }, +} satisfies Theme; diff --git a/docs/bun.lockb b/docs/bun.lockb index 357eaa0877b987d2667b29dd269ea8caec2b78b7..263eb4a24d87accc42666d40cb94dc9371ed9723 100755 GIT binary patch delta 15120 zcmeHud3;S*+xFgDj^v0#LdZ#SB4P*$A~_ieCkaY85iyGY92#dHTJviJ><|=`@Y}%{oe1d?q9BT-S=Aen(wvu z+B@sq`psqQEZx%3V7JH`NduR(zSK!L8}LcjY38^09!VJMuOLT#i^cTwyIft!>fA_0OQ*bfDJfU9(ZP#1h2%oSu678Xs;&lYN_ z6>Amck1H%fnlQ&z5V+xE?PJH~4i^LwI#-nHrj&~`K@WXGZjs!h5rx?k(73|v!p!2* z+`Qq!L|A*nzz%K*wyGSZa)8RUz&tX)U>JBrE~|W8}EvJG4x`MbCa zrLqvNMl@2nHkgO>A)3y7P33P?KB#iRxV*gLd_gdwRsOK!)|tTnLhD%n3hV>k3~mIT z2W|$=0XGKs@WS|WLJLGR1?#{~z*o_{0Pq(oZv?a50#zRi=8F1)dFr}?dF~5ya!2Q4 zxQAf8>p)+HMD)dx3}XzQV-|EH_*1YiII1v!+&rFifAosW%LDVsoC{QZtuz7M z<^m$XZ15!#&>6=*Fh<$&78q@ExHebj{w~IkeV`J|`HVqIg~PKacB98!;TU_t=+IGx!d6u;vS()6GxM@n zk*M=7)z*l%Hng>(ElzE*{?Q`U7NfS7e!qr(zjpQqD-*c{twA^XIuhC{1J@eN16_gy zo}k8I3Ri$RzF@@gER4HQ1|24jtZ-#~a|_!{%&`{Qtano9>(slUVECFN2+R&x7wiqbkAm1A_JMhcxuQY5 z0=!h+(ore@AsWUF_pk^;8*m=d>k3^22gXBgz=C)s$vl9?BgQcaAqmPr=G%*M z*rT(?jUACWZjxZn8doqD`knZ)uY*djAUBWGDKL-cp-xJ(igL$J&YqN=m5+F?J_F2d zUNmk@9x@B?Zh1P2vqHz@W)+N^*G19C3@gP{pi-LtM}->YdbghoL_SzH=THs!rUBgFBi{PJ!qk2=#Fh}Cu-0MSEKQh z`E%xNoi8;#kse_?lQ*}Cxo#7ocyDh%T3UO*NAj`tJvtvbxvA7~G_&H=wmszLy30+f zTXlNCXBQ4psv${lM{D|^B?1L{#YmqDRMEhq>n;jHGM#VO!39ElTHPQ{cM(!oSqhR^ zI&bXY0wGC``VmqmI$tMFYFmTSy)DxC8szI`k@nS~3U7<9ri)yPcbt9+q-4}4(Yksu z(m5AOH(GRwIzdRI3}c*bC8RELiBBMPlBM{XYQ_55kTAWD8g$7cM)z@bya5j=%!@;$ zONJP!mn)_FTBN0}Q~|1VrAkm8H}dtf=ttub#+?ZO>E$y$CYQsx=$aVuDCCSp7YUygV6pGulk~*PU z+E*>r^w3gMs-@Q;byeC@Ej7WtLW#?%mbO6ZBHP`qmZIUjO5BucX`d!Zp7qJMiAC2A zD|Zn2H;L1|3TYr^H0$6}9hKA&w<|eu6{HMV`V~^HEZMPU?XvV4BqcQf>vtsiqYwz$ za^g)$LuIK47P}&CgrsDsiIt?pWkVV$+wFs7V@Yb@N9jQpDb@kA^!#)+*r_}_4}b! zcSPSB4`FV;oJBtk8V?1Q7pmH(Y8V(a|9fb?lr(fLqJ=UC$}r_YOXgwH?Shml513m^ z43S(ia_a^|i=+&%IQ>#c++?M-LNs}412}rnq%I%`HJrhf!0G_B=1C0dV7mrhlg*RmMkSiQAK-;G&hPW z+go&dk=Bt`w~v#iMpJs6Mb`*(m_!+Iak>$Z`pD8QNXfF~f@*rmQVJwI4Pf^+q`|Tz z;WnKjOR12Q9IsbP*B}j%Q@f%yO35oADLJk}N|jTiF=silv<6Z;xp8MYP7d$)Q~`=lq)O1_MDq2pNZS)B9dsROAiqvj3F_8~d_67Fj82pey3mO# zJT3ZY%m@3wKsh2vI#W96ac8Qihb7WQ^MFfjV%?yyJzNFr^$0XHpQjKj zRR5B4^HElI95nW0d9tO6FHyQzGz~Mjw5y3t0Yd`ZRJjhg27qUZd@*x6wmmZANg?Ry zNrE@kPIN29Zh`mta*jq|zFx#Gh{tVCV0+xe99@}^nn3e*Pr$k7Vp@g(G``u`r6DmDCXR8S8^PgOhchpg8BUmN~c1^qYD*->Ty z>`0aX*2*>I1l z{~5F0$EqDO_JhJ#09Skz;1T*7;8pVtAW=uFcPTgbJJx^;DqjTafGYrB%sf6-0NdXI z_+sW-@3Ml6ne}@B*K!}=>sjXXUjbL(Hy&$_Py&Tn7ZET^a^n9Tb4U2igV(MHnDu&U zInOdj)fcTwMP8}_GiPY1>dbr(YXq(XZVl!UXsf0_$Fw-vTfTRhRjVj4mlmVy?ZG@Q z7FFkOfA|wRsoa?rT+CccS1{*KQn`o9$zZ;i*{&CuTWJ$9o?O8o)qt4|hN$|Bm@62j zra#LZWmn^$Wwy^!XNM0SZkd$#bc<*#RmvU2|a zKSN^vhtCii*s~}hY2HhN#La!W95{SGdfeD2?`{6Hey1^aZ=c$B%sOw{2)By~9*4Ic zbqwrr)z~ZbdQs$MYtfdV7BgmF9-cW(diU|HpU9A6q+@ATu?G1Jw9%I-2AV$5D(dJk zv`M`T)F$03y3*uy8?{U|(0OQj3La#mZ=vlSU=`hI2DEv-4RmFYRWwleU>n8uG0^hC zR<9yCH^L_5 znPn53QZB+~bO2#<@)>RugJ?X$7IYY4OA5@kiNQ1(VF;Z>*ouNj*u>T}17RCFi!hYJ zN7}@;G#_CYT|yX6?Q(3QnaU7G&~=27l$dK1qiAI=dNR~NPjand40Ru66Ju!|!gllk zVSDO5+9t-)MuZ(m%(ICdX&^!iZATbS`Y|>!f$RtqX*a@7g%{YwUNj$JDqTX@o7xrH z#6DDpurFOl*pCv6Y+`>}iEsejL1?4y#WpdG)*&274-lqP?+G?>5N$*_n8b-TF@pvo z975X>4ki60n>dW@2<@~RVJ3M_wuxDkI~m?J&OpZ|Tg7bhnF8<1hp$bsiX-VTw3g%H zYg4UaE=`^a?}Bz7+Gq-%2Jb2`(Bf%UaSWY>7F%ebj?=B;IGR5l-UaPPXyd6}3B0Sw zK&wlvVj*3JmQ-w@o~2f?m{yizPM|%3Hj%nJ;9V08^q#{iPNoOY(k2=xV}@0nN*iau zyC%WAW?IGRG;k)o3))_2rKF!_qnybG8Z*l(&Y<1Uj8hEc|FTt_MY%7df6$IWn@v8m z(Z8wa-)yTmmkvW~ISu`rV-@GqacwDZswQt({#Z#w!n*D5Ziv(REo(7$Q0bfK(=xRrvJp?~wy_hnXbJDr8LVgdS2R&fW-r(Tq>umK(GX%#;tAGG?{g$6pE zVik8%U@!DM~^rSRV9AGGDYt>UM230lq) z+>QEJ#RF8<2mM=$yAia%Q(|BA588&lR`GMX18q_n#;l)J{DRi?L;sfHZq(l@9;V*? z(LZP(LOVj@0Q8Rxl#P4gG1A+5(Oa*6r|13sM(n>D(8+a=$YVuq>8L9;T4AQauetf` z#WvqVz-J~HX$J$&;Dytj)-Cs@r3RN;d^~_p2h6OsR)?$#rqk z4oAfziCVvLR3}%3xWCJ$l)A!AI-^Hci$vRA-OSl(>8ozK8i{zZMT_pqmGCDcd_Hir z?m}ypSL~?0-p~Tp;kDBE?HQNjC^bFOA@u2Q%EeKi0NgeFJ5IhdeVdwP{Xb~gk@k3c z+&SW>#}`Tdmyr-hGmh3TO@M^z`9nN^G?m{~Jy90FGK~O60y#h~Fbd$8y`De{z^|zd zfcgM`{8$Jq0$u@@0Q|zuFX2A{KLfu2yzT1>bOVz3vtD-y{8rCxN4Mn{W`2`Q1$qO0 zfWAOKpg+Lx!rp)nFpHWWYud2_xn=|WKK}rC2s{EF15bdb0Kb8Z2J(P0z*t}$kWVii zYt_9Eq`p8upg%AGumNenKp-6$1Plf;fFZz8U>INrGJz~$IE}}UhC;$ua{gv5f5PJl z4FXyKtpNUp*cb=|_?0#j;8)(E0N$O2G$0+|_ig?!W*30p`~!f-Kp@ZrXbLm~f`Ar4 zOCXrvy+a`IfBn~>f;WJ*z&hYf;4NT1umM;FybkcohyeTFK)ygY!22yLuoLq8zz*O8 zU^DO@@Haq2x*ymC_yZpS8+i!@Lpbpd1h^ch;d@O=+3q#qOW+HD%R+WJKQB1`Ucj%| zUI0pvU$fc4b&xsjSsT_}0d^O58+IRlMd$e1KwW@e)eQhvCC8WYzrN-7bv9z~yE_-a znSFqUKm&ja)+*%&83AvAE8xM|0`Q=N7ne;R+PsXYo(BoG0Z0iF+bCUz=zF8u38XbrG4g#bLWwsXfpRhy`MRWS|GY9ZLmz0^B(*-m1zeYJ4wMf7XT< z6YHFp%i!`j-&kM_kOz$B8R3=1D~wlKKcFu#0N@qKnMMJ*z(^nyumi&YUV-TV7dlAg z!76hcuS{N{n#|0|28IK?QnPq4MnK2`IFTzX0C?J728wtlXxP_YrNz)D1Ji&~UH@0SkbIz+&JPU^&3f_?#0$*PQdW->BqN!{#dxRSvNK zt^(EotAXvnR$vS821cxY>3fjg0yYEh0-Jz$fQ`W4fH#4+fepYqU_G!F;5?khaT-|X zysWQ%hM$dNnafpel#k{du@>M$8QTDkd*c~?UybLq9l#;rbKpbZGvEO5DXAtEI^uYvxubQf+1Z(1VhF0?Yq?043r0z)oJ!95s-o$S+o9N+v{R$vo+nd=94yIl z)^Nd9rGBT?VA9TzHmrX&x#hg10~n*2P;(RpAi;&!d}lPthf2}Z ztEp3J^z6TKr)Cf%On0HLQLIwEbY4e|&l^qJ@wp8_|I874Y)f;tLbX#U`j73j19f#f zcRg3P=D`f-OakN8dS7*6TnilCuL`pg zU*vx2OlhL0@4hvfv;&woHmr@_e9q!67iu;mZ+AU;oHa^A^b~T|Eap+hS)VBF6rjsZ z*NE{yoGO8J4EzqywJLatJ0|4m&->d2v}$-ru1NOCCG_rDAHP+&3$oWWKeVz}+LLcy z;d+$rZKZ#njlio#{mPMeHJDl%L3c0Qhz^1ya(QKK(-#MQ*s-0LSRXOCH9Nw=wZSF3 ziVMGtJ#F^laWeBjb*x20?iru~j$SgFv@_3Z z{KEE}x}KHpGzh4@?6NUhJ0orI?s9$2mI+@t)3sC7?{>}2D2Q+Ix--RIn^G>R zlj}VE54ODC%W2THKFz#rHfg7eKlW-^FJsBdnJ!{vs5z27e{6j^fy%Yx$h|A7suI?o zeCjmN4lLI!`g(ZY@q3ap<%{~%=wHTY?Syme?Ww)$c+5TNG|?R#`FP{u={rJdZXNsu-b@<*W&GMs!D?a!( zm;e2XmM_)qH&lRVg-wwL;xbBmX%MPjf z2_TypO_BccPTa9W`hJeRM^cD{MHLwufyIyeM9~$q(z^d{eNwkZ1q^<94OqoZwM3LocoE()ZlDC;d4 z_`z<>=qYz5?64himbEXClCK#}U&4UzfK~BPhbQSiw8H?me=gx%AUUp?C1q43|0Z<& zno-qE+EMt(nM(uX{&674S+8oYQbbcqy>2vV2jzDJc{fv*ud$99|vre-(I($!!}yJ^N3uZ1@wq&va1|EAIO2qt)JIIcGu zHmFYB#vSp@z%z?4T?qYj)0|W%L@|i#-Qm_R!9{oYp`sWVk>Y`@sdHl%t{76W94RqM z%66piJ@x)b-KLekM=QO=w?k;`En}_Ekx-B4NuZ^-Uc6Vsn!#r7MSC?RrIkn*ZW&E} z*pYGNZd+RaeVONLdwAcX7{rTI??-u?gDRvd9S!@@XwrTyFfsaZcFDqS-#N{drl@wj zIg)cJgx$!Ae;diGO5W8W;f1?8rCK#-o8MhRQE6;&_T!f_cd-Y`Xm#yq!SGHV+@ zrNlp}S!t!(bdqlSN^|g)?{@XhG1ZOw+zx4`IfM4Qg%Q1v2Nl#C!;1+kCDa@yB($Zq z$o4zuX&gpXw?~*JU@`H4e`33PYd@&921W72*EQIN8I@b(K^lDH1VE8iMv!aZM;_KOJZ zSiSRBJu!+l-!n@Oqv+y2W3=|egwGnfFB4Cf;!Pnuw4Hp%{?EHcb<-%sMpNid#!)uB zK=Mw@w?T8y8BO~h^%7q~412cv>kDD&58qz!S$gnQXG#_4A~6lP-LN zmnf}~wPL9;+MsksQfiWvT)!hVO>MMlqGo?yd!dOE`6s=6Q5khYACwa7A%X|?!x0`K5{o|^$>frrKOC*J&fA35l z)y|~-;$`2|uH8R6nc^X@U^6>>emtd|#%3~J`QeTB(-V0GhlfVsO%5sS-J5bod;4s4 zg+Jh)5y@-&N<6)OdW3W*o?N~$OZOuw_M2oWB!T99Q^C~aOtN&S6Xl4BeW)z#*he({K^J@)Xo+VBueqr|cQFRu*tsbZIzRJ! zFE1Z^!hcXqH|TYtU#@!aamWXECk%kz5c6C6!&?~Bc(v^M7sN+z>ELof!|6M z7PiUHD;}9Uwhew}R(_z7Xrj`Go@OY8ZQHbckx^kA`J+T=(a0&v9k5M7R;W3q-0m)# z%6HZfjWr8%>;>7wcYakvoFtW>t}FVLcM?VaotgQJzI%h z<%KoGmadt(W4XHJ@nXQvY3|~h;PP!Iv1a*hQQW)yCW>g)NYs}%iNb#o?T?0+dvp}t kckYc6%k{MKi65GLnLHo+?fCrBbY1xrR943Jv z7y>r{#&UZn7ISL_;RiI{6Y=3-t|$!#$Y6U1I&%Obxxr;%19-8@r7BNDpg+kR~{~DLosXK0YsN zlpxGPX0E6T@l9x`*rfClI@uU8pMo2K-%Y5R5-ty2?FNPExt0$_05jImHtMVKyAh2livY>}%ar zJp$|n-2?m__$LfxbMWV2UvLHZIiXarErrkw5jkKU^zPuM;4qclz+Au`xE9Bs0dqxr z!AP=g1M{R7j?EgE1!s8bq&T^RLNUL#N-&RkH40~M4TO#?wwKTv*HQ=tnPW01BclNc z+~SKUfD7CXzvW4uIw`9tW2_*|3{*y@Wec@uU@mYR;(6+@@4RlA9!vvSx!=L9R| zod)wrbp&JnZEu9Yr@4T25V*qDNZ`2%0K> zQ!y$tzc@Wd5Pl6(eCit51$I$tgPN)h)PuRf85wz{#p8T ziwI?I6VM>;*&8v+P!gCM*c9l*d}Hb$y-k~e1(_gAuv1DPB0fd zp&&Co110QCP|BN>sKlq3l?Hi&+1E;sCMk2_2j+r8k-*-44?27OWpHC~rD|8A@+vT| zhD<7L|R+QbxqJmNrDiGJR;qR zjFmDas!lLVn?@^9jQ99ofG0PbEY~X0YXQ)j*lS8wMlhdDWri}mk9S#B9^*Rc>}X_%9W}??rs#~ zVU`BFQ8s9q8`joLDvauADxA? ztVX&}BelS~Qc?>cb(8J(K}wb-9d<%R>RuzgSR-Amkpi%~6uaCS>Af21F(mYj+k(}n zNDFJE&ugTHSgRN(*bS_aUa673tC0e*Hf1|$vNu(Gn{^vZf-snFc_-+8hcr-@`ub>b zJ0SIu<0NbvLuF|=q%2wb6jHh@1!Kz?N})c94iLsrZWCF^l+$|q3c_$%s;H6N{It?? zAt|XRASv|+;ErnL9MW`u3TbMVcKK6wQ?sspGdMTpHbs0hs%~o5??*&DCbJGzxW-Bk zno+i|S=Y6>AoP{3%9~TQuUY>yB6x*h6?n$#`~%|k`XkWTGaU$;u5$}P7{tp`THk`I{mr_2i0Dh(ux)e;5`>;GtShgwbVbGLqU^ez4_Hso#^9QX3cI5#|TDv$WDBO0%@Ox-H0N4QiWA%;0 zYKFrvR%e0MgSItD(658Uqpl3hX=thPz%*@5*+FJ~UTX}DTqJk-5Hxj6(aQVKxXq4S zffN-^*}-NhJDkdc&HC5FmCXvnh#mV9v=mr6%a*4jC_BU~nIow@#H`E3Y<8w?Aqlz) zNL^&wC*@l=hpo+w(q5nv3LL1RY|WuG_; z4MU}Pf#lehsw1$=wxy6rvsBQQvOzoBQhB6VcNN8VlifW$fvTg-QfUHZN1LTj5~w`d ztb2s}V-n>?CrEn}DWr{AH`L7I6WS(0w;57zS-KA?RhBxTLEU6&38VqCbOq87S?bW9 zw@}Wz43d)LLXFe{gELG{oeN1R`79(QM*vnxPdT+1(pXu#2q|7}T%%4D5^vUR#!bsg zq45d2N09o+()7-PFoh-QZf6Q<8$%Ne4q3Q|3XD2{lL|L5U(61GCo8y^*$#WId_9XL zqP*p z7ch|m7mN{=yMtkoFJ{izMP)dVJT%?GeAQ;II1S+8=mqfgEOtPAKY;D~YWL6R!e11+M{o)n=Zu*8xs{1K^99^KAjRoE?BO&;MQsd@-}Z2dv=wcg#NW zF~IgmR6Yvk3XcKYfX@I<{~X}>Qz}=1`C_h~;1Fc)xE)oU}ypW}FX zrE_E1na-at|=)>ka1G`l>p= z;BmJHtNJh=Kghyx1k58iP?-zJfX)SEsys&JEY*%}c_J8W&y8pN=l2dgknzPE7hlX= zVeOj+$Fu&|&Ev0|hw#_U0Kp#WXllxLD#q}~!@lp#unjL_49a_LLi)f(y zWma0-+dyZaxsu;ZsVjS&37*APfS6e!OFoC=VSj9xjN0>xM5t_+wpjB)~QxLYNDuf*< zc#u`>NHY<3qVotlQ^a7a_&hB{*oD4B*p=dkSjA*ofiQ(`AnZmRhFV1nl_5-}I|#c| z$}p>#MjH|Kpoa*1Qm^4wu@`MY*qg)=Rf8?=?JZ~2jKv6A88c_ zQWnBNbO7OC^2)G^Lnt5NP&$fm82OE|ioQ?Ui7NJK5dDMp z7}^p_DMJ5B(7z&!xQre`OD;wKiY?*_+ER@EK{HIWh(rS?qJQ{?w-4Hjq@RTT%|!nu zS;RH82b$9?^l!37ETgQ+=pVGtpuI$1Q_#QJ=-(8J_zE3`W}JimO|^)BqbXC-KWG=B zZKU97=-*uQZ<Pw}_i*;dJy5+AU~rQ2Y$^Z$A1r!y;~>8_?nwpnoM6 zaVwRTpnuRFL)%6vrRd+n`n0{Yo4A7>LQ8%D{j*ub3ff{r|DYMLk}D~F7W%gcJI^eO z_#S0pj~cKTeVA<#cahf|^lu6JFvlY9p`*}tLkpd25#OgNbJ4%0=mWHU6g&_8TZTT& zvxxiYJhV@tCC#^p2Wa7Z^lv%(0PPUPFF^lRpbrZy;>UCY+Bs<57h1$4RJIWPTZukE zJ4z`ppnrrpdch(dr-#t4LmRrN6Va-7X@kLm!e4XJy@W?;J>{?em17J6c!qWs1lwUe zt$QGLmu&a;YA4+=JhQtY=C!)~Tp!{>IDv`h9?#gYSp(rRlrXY;T^V?VtP8TPKXAEnpA?1Oxa$ zEbvPOzUB(}=qlh_Du4PDA^?2-6!49cKeY<@YAN6gq!0_l0X#Z^0DpLD3itwkfIrX- z;8z@eXXV$z2(&8_2nV*{-^fBaBDVtDfb9UkPx3pa2jB@b1o-7R6BrGQ0mcG}0QV0c z4Efuo{O+U&*8`jZ{=Q=X_+^k^4*3j74Dc%S3g8`}QWz`JMrjtRX)1XZUW&kAszj)h#nZPVy zHZTX63(N!N1L?p>AOq+M3;+fKgMeW`FQ5<57l8BdzuVlOqFL{3bEEPth zx#z51iEPNC!p$!vS{tp#VF^U|`HBbh;46FeNV1Hwm;ItQkRkdV}W2^;g=jXU}z)L_AAP8Vr;dqW? z{cpf40LR0&RIZo{Vxt&fJ-~?@0B-3f;59&N`RkD126h13fo;HBz!u;Q;7y<$*b2M@ z_yK)@1VD2|Z81H4N*BIpRGNvTI>0VqCvXh-6gUFx2JGgF^aT_CxExV zM1X71Lxt-l4vvf&N~_O!bN6Y-nb|QslpgS-52tlW*;$q5CW*r$!Xm>kBitizq`Y^1 zc}d9o{j6$AB;Sl_{e7cJJ4;zUc3fkx9gYDo2oH-6gBL}M^u_(rQhSlwK8Tc3L>m7f zRXQlr2M^XMWTXiXqfOc&%yR{%wSU{$t*Klmu%fo1?QC$l9EmHEW zOGAE3HGS+TZ|$~%w2C1Wm$oM(C)&kVl_TZcF`BfqLsw@zPo5ra>i~nOu$V9y?R27V zzc$7ka#DJy9qxev_d6n7(9Y0RZ{85|)&+B8B_$GhtDPw9f>CoMT* zS4-_FgX!^wD7<7vd@}|wNoC(eNhoZ?S)=rho?iaSXwuG{ZQIy6CVj@YYb7xXbw;3f zU+U=;47Ag0Wk2`px8u$auiFhC=;>y)QA(>vZeJVKVyWj@??2X{Y9{UUskry?)M1B9 zGVJA)I@6bDBc;X8wDi1DDs!ffZfeDuv@@xVJg%k&El55fk4a>kusGp>3r#p@G--!a zulAf;r+dG$U7A6x@Wh2Sor~0}*UqX=ig}b-vZ(7f_UiNMlMCuqheahN(xe@Yb?wyU zf@{*PIIZ+3L2d0US9Fi#2d=Dm)1z_M`}UN= z1~eX7wKKBe9oG%tRo7Lr8)&C!U)@rYecLJE3wz4e2K2!tqe(k=>*Q{3xm#Ry!fsI2 zfPO~VS5UbpdSm?Uw}{@yVlwRp+ELzv!tJhsH>CFV6oUtuFB@b0FbbSCq(M-Wxaj+h zb_4Bn@W@7w^sY@k@7YsQJZSM{qe(kX{OLVg)9IV~k=-EQgFZsp+WF(&=2IbuRavZv%Up;q4+P1=Fv2gAxrqF+At)NWAGghqU4jM0uT z$F|rO7y0|CE_MU$kn_r!rhz3B?*`dZJWRA5S+!Hq?HqfJE?97Ml-)o(H|;aEhj?ZB z8Jj(2jENqhS=vGC1qCm)xVRw2U^l4tr|`cUC8-&m`rc^z*R2AKV+6Fo2}I1yqYvuPJ~uUKg>(-mK-8sB}Ma14M(gg?fXbAtE~M~K_>0+ z^lYy&Cyuok?v2$Q9~REJRdcl!YMbP?H`HNfE1QwqH6zXW!CTS?(uN<5G1{@^jV0gs zcP(+?yK5ARf~|J2+4;xeeWoS3d}mL2K9FuBt9B&2$DZ}?dY|c=1%ntRt9EF6Xy2^^ldlEQhgXc!uR(MU z8S4d;%T=REJH+kf`r=$ZfY#mJPuNtL}!8GV?;js7H)2ny3~bzR@k<$R*;CXC|2*p- zsxWnEr4)4F!L?}6Rm&r?c6DeQWr>TSwE z(u(Uo_#nLFx|h@@z30dLeslKKUw68Rt&q|HDY$w1{wP0MEWc%x z4(Vw<3VPN91Qt*nKVisk*fyu_tq!epU%i*_$x4d+Xd&ObQC^I8pnh}U<*{P7w+Gnm zo^@AON>G|&`tz)6TUEmS`Kuqb3iw%vuCiNfQ;OI8{ASlhGZ*Kj`(?mEwN2`xjc$8>$+wN2pLnCe* zP1+9#t{lGKZHTl71FSw*3jgGU^JD4L+oPq6u@wH3F-H5jzzeBvT_^ir9tNL};N==o z^9zF^dlna-Haa$tR|6i2@r5OhN`8uzj>T2J^HWdpKYgB|Id{C(M|f#x0`0vMDa9w! z?K{R8?L_~Aol^x-c?$uEgg?-@vQ>+sqbyaOO;lW_Opsj z-=4a5c}vy?dy1!-zWs;Mr2YQl%)scm$(O#uL%)_a#Y}Gh&^n{mBq_Q6iIi4IN~5(j zHM^QY)t+ghMyg$UW(GCwk4;jBS(?#_Z1;?%+7Cu1`ZfF{`S5O&n^@LKnRV^AC_l`& zUH(g1;^+31|0a+2`;jAI^SfF{dz@6=P>20gX^Gk(X=@_&yl<@crurIv{UN@&d(tPr zg?C$q)#1Xfb+@z8uXfl>h($ diff --git a/docs/getting-started.md b/docs/getting-started.md index ca4bb8a251..dc49d4c5d8 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,7 +4,10 @@ This will show you how to install mise and get started with it. This is a suitab ## 1. Install `mise` CLI -See [installing mise](/installing-mise) for other ways to install mise (`apt`, `yum`, `nix`, etc.). +See [installing mise](/installing-mise) for other ways to install mise (`macport`, `apt`, `yum`, `nix`, etc.). + +:::tabs key:installing-mise +== Linux/macOS ```shell curl https://mise.run | sh @@ -18,13 +21,54 @@ You can verify the installation by running: # mise 2024.x.x ``` -::: info - - `~/.local/bin` does not need to be in `PATH`. mise will automatically add its own directory to `PATH` when activated. - mise respects [`MISE_DATA_DIR`](/configuration) and [`XDG_DATA_HOME`](/configuration) if you'd like to change these locations. - ::: + +== Brew +Using [brew](https://brew.sh/) package manager + +```shell +brew install mise +``` + +== Windows +::: code-group + +```shell [winget] +winget install jdx.mise +``` + +```shell [scoop] +scoop install mise +``` + +== Debian/Ubuntu (apt) + +For installation on Ubuntu/Debian: + +::: code-group + +```sh [amd64] +sudo apt update -y && sudo apt install -y gpg sudo wget curl +sudo install -dm 755 /etc/apt/keyrings +wget -qO - https://mise.jdx.dev/gpg-key.pub | gpg --dearmor | sudo tee /etc/apt/keyrings/mise-archive-keyring.gpg 1> /dev/null +echo "deb [signed-by=/etc/apt/keyrings/mise-archive-keyring.gpg arch=amd64] https://mise.jdx.dev/deb stable main" | sudo tee /etc/apt/sources.list.d/mise.list +sudo apt update +sudo apt install -y mise +``` + +```sh [arm64] +sudo apt update -y && apt install -y gpg sudo wget curl +sudo install -dm 755 /etc/apt/keyrings +wget -qO - https://mise.jdx.dev/gpg-key.pub | gpg --dearmor | sudo tee /etc/apt/keyrings/mise-archive-keyring.gpg 1> /dev/null +echo "deb [signed-by=/etc/apt/keyrings/mise-archive-keyring.gpg arch=arm64] https://mise.jdx.dev/deb stable main" | sudo tee /etc/apt/sources.list.d/mise.list +sudo apt update +sudo apt install -y mise +``` + +::: ## 2. Activate `mise` @@ -36,10 +80,9 @@ Now that `mise` is installed, you can optionally activate it or add its [shims]( For interactive shells, `mise activate` is recommended. In non-interactive sessions, like CI/CD, IDEs, and scripts, using `shims` might work best. You can also not use any and call `mise exec/run` directly instead. See [this guide](dev-tools/shims.md) for more information. -:::info -Activation may be handled automatically if you use fish shell and installed via homebrew. This -can be disabled with `set -Ux MISE_FISH_AUTO_ACTIVATE 0`. -::: +:::tabs key:installing-mise + +== Linux/macOS ::: code-group @@ -62,6 +105,53 @@ echo '~/.local/bin/mise activate fish | source' >> ~/.config/fish/config.fish default. If you've installed mise by some other means it may be on `PATH` or somewhere different. +== Brew + +::: code-group + +```sh [bash] +echo 'eval "$(/opt/homebrew/bin/mise activate bash)"' >> ~/.bashrc +``` + +```sh [zsh] +echo 'eval "$(/opt/homebrew/bin/mise activate zsh)"' >> ~/.zshrc +``` + +- Activation will be handled automatically if you use `fish` shell and installed via `homebrew`. This can be disabled with `set -Ux MISE_FISH_AUTO_ACTIVATE 0`. +- Make sure you restart your shell session after modifying your rc file in order for it to take effect.- + +== Windows + +Only shims are supported for now on Windows. + +- When using `scoop`, the shims are automatically added to your `PATH`. +- With `winget`, Add this directory to PATH: `\AppData\Local\mise\shims`. + + ```powershell + $shimPath = "$env:USERPROFILE\AppData\Local\mise\shims" + $currentPath = [Environment]::GetEnvironmentVariable('Path', 'User') + $newPath = $currentPath + ";" + $shimPath + [Environment]::SetEnvironmentVariable('Path', $newPath, 'User') + ``` + +== Debian/Ubuntu (apt) + +::: code-group + +```sh [bash] +echo 'eval "$(mise activate bash)"' >> ~/.bashrc +``` + +```sh [zsh] +echo 'eval "$(mise activate zsh)"' >> ~/.zshrc +``` + +```sh [fish] +echo 'mise activate fish | source' >> ~/.config/fish/config.fish +``` + +::: + ## 3. Using `mise` :::info diff --git a/docs/installing-mise.md b/docs/installing-mise.md index efd7eb049f..6ae60664b7 100644 --- a/docs/installing-mise.md +++ b/docs/installing-mise.md @@ -111,7 +111,7 @@ sudo apt install -y mise ``` ```sh [arm64] -apt update -y && apt install -y gpg sudo wget curl +sudo apt update -y && apt install -y gpg sudo wget curl sudo install -dm 755 /etc/apt/keyrings wget -qO - https://mise.jdx.dev/gpg-key.pub | gpg --dearmor | sudo tee /etc/apt/keyrings/mise-archive-keyring.gpg 1> /dev/null echo "deb [signed-by=/etc/apt/keyrings/mise-archive-keyring.gpg arch=arm64] https://mise.jdx.dev/deb stable main" | sudo tee /etc/apt/sources.list.d/mise.list @@ -237,16 +237,20 @@ This is the recommended way to install mise on Windows. It will automatically ad scoop install mise ``` -### Windows - Chocolatey +### Windows - winget ```sh -choco install mise +winget install jdx.mise ``` -### Windows - WinGet +### Windows - Chocolatey + +::: info +chocolatey version is currently outdated. +::: ```sh -winget install mise +choco install mise ``` ### Windows - manual @@ -356,6 +360,10 @@ I'd be happy to help you get yours integrated. ## Autocompletion +::: tip +Some installation methods automatically install autocompletion scripts. +::: + The [`mise completion`](/cli/completion.html) command can generate autocompletion scripts for your shell. This requires `usage` to be installed. If you don't have it, install it with: diff --git a/docs/package.json b/docs/package.json index 984c2937fc..2133abf72c 100644 --- a/docs/package.json +++ b/docs/package.json @@ -14,6 +14,7 @@ "@types/markdown-it": "^14.1.2", "markdown-it": "^14.1.0", "toml": "^3.0.0", - "vitepress-plugin-group-icons": "^1.3.1" + "vitepress-plugin-group-icons": "^1.3.1", + "vitepress-plugin-tabs": "^0.5.0" } }