From 357e666ce9368b23686d78646ce8d64d7f07717d Mon Sep 17 00:00:00 2001 From: Willow <42willow@pm.me> Date: Mon, 15 Jul 2024 11:32:00 +1000 Subject: [PATCH] docs: update installation instructions --- README.md | 2 +- example/bun.lockb | Bin 52787 -> 52422 bytes example/package.json | 16 +++++++--------- example/src/install.md | 8 ++++---- 4 files changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f2d52e7..f3cb286 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ ## Usage -1. Install the theme using `npm install 42willow/vitepress#main` +1. Install the theme using `npm install 42willow/vitepress` 2. Import the theme as shown [here](./example/.vitepress/theme/index.ts) 3. Add your preferred accent overrides to an `override.css` file as shown [here](./example/.vitepress/theme/override.css) diff --git a/example/bun.lockb b/example/bun.lockb index 2677b83d0de424f4b411d49262c64a33977c1f40..0d850e1476162a938b69e8dce28bb9e592009141 100755 GIT binary patch delta 9343 zcmcgy30zd=+CT5WC}VI}o`3L3<|GlNSC4ycGYAc&!&42m1LkPCy?5=2sb+%VS` z6N}Q%EV*V@*U!>4t?yU2EKN&q;Z@5P+x7mRGv_eY?cVQxefM^LzyJGxw)5`iIcIp; zzs2QPv&))@u#KAP^qX#5_O1_|mazQBA3Un2oeKTvv5GAR+IPmfG-UY1pOoaQw#gb) z^HYsOah8K2>LkfNe_m;au?zGgLXteeGc=Oa4cr;}UEo6KUf{`9^3iLz!+4|J2IT`KY^c?yMOz=FOI*PfXOdA1o-BrhMSM(PQ}515x8;L8f1R=7>!$H3j;Ujyc;U951K!ebRqSNLv)^$NQx zd;{y?gZs}b{JIzBpA82U!!9sl?dud?rtoZqixsXcvrV^QckBgtM5i%*JoOeo$JD1{ z2{CE*ijuk0Bg!kKXhp9onKY?n(u~qT=sb{@YcMY!5U|<8r<7LMyy4)r9fx({fMHOPeI4*+LvNIxI?ze@C9WhRnkt_xnoUWuBXCQRmJgT zvt~`_j?_%D&7I9PTmpFHZz=pjh@+vsVD8Xi*m(&a1#<(l=a!aCMpY-U5xC+b*ckj& zG=SN^tFL1ZEyYIS`&K~by%G!Ny+*KO$!qN85O^d<90t1$0qCqf8_b)>sNB$^_+6mu zVZREU_s-i2=Yx3w>(N1;(P`)iO!kO@j(W18V|DD(-I5dzPDET6Y-9WTF!0m`!ODy{ zxyK;+q8+XWJ)7ai<1n-A^J*Xmt@Pjm`9Y>BM>YSGncr|P`_+UwER zH&t&hf6KOY|L#Z9;&t!R4!3j)*13s73e%azc(S2APr+lq)~epv$oPjlCosa8A!56+rw3rWwerOQ;3qtJIG22MY5r>++F2#$fb<_H|7V2dKrvtm)=P<)J1`o*V56HR(1W ztzgpZ8rtWPAkb1bvsR0}RY>98QndF$Dv+hN4x2AFPOfa525EvU9ff3*rEqMM5?Oi( zlEeE~NYiB77_4EbEIkitqAc~m26IUBAUW=MtHTzBZRqI1N=R0|LtG@Ak6GIvPfP+` z>z?Y0XMH5K`lM**L&}n+S2`pQY(s}_e226P(g->3b4VGol!*Q8knA1OYaNm&cD2Ks z-y!YjkUn)t`czl!-C>TdbVx6BNE+<$VRWrWsw;${a@eX4=}d>@izmt9%~vJO76a`u zn6zhMNTyapipJNE2KbqDR&4$xET0R_>6)Nf<41e^OyVT9`CDJQiHPV# zQHWSzq&-HHHW<&KiCT>*;t>k-H*32hA)#Jlil#h(_V}B$&%!WR4!B8S0cK5BAPopG zX^-O>worHg+7F^D0Vd7RAQ}*8(lsCn40d$GCqbN|mO!)4HCU3&uzAov_XOP#Xc^G3 z6a5l&4bURxc=)u3pe0f(o{KN3J;NzjysPMCeCzN`mNun`;en3+Gi%))GEEI48>& zGy8%80btVQi&+C;M&*my1;AvfUGIt|BJ(uFU?Up^fN~LzwY>*?A-pp)B#@eN`R-l zO5u56zJ854ZocewF!H$c0KoPK0j{qO9|-a$TLp!$JDCF;fzH4>fc5nNU(Bp;P?jp+a>8v<_5L^9Jo#KGrIx16rGtzb^ze`=K#K#`Kf4Q1s5~da|mGj zivV9Q^8E9SM-+Yu%#YnsfCFCz*#DZs$H8nr3Gh?!XMitewx0#Kp$`;3ukZyh*K<+P zKUVabONs!J8|KD;$9&*;{<-lx6U6VA4>14#JVE?t{5>&XIS=sq|12T=&N{dMn>xUo z?B9?NYUEvcM?(0W^MO2mN8;cSH3Q6d<^ia(&X3Q(Js)uU{M>dV1jyXb5rtm@|0nZ- z*Dn*oB}$5_B-iLH`Zmg)CPZ6=3$;XBX?L_cxyM+9mI`95lpo_xhoN;QU96SdV%@1C z)*^J&2JIlUfH;e|i)?XLDvNWcQ_$SW5N{=YygMz4w}@_Z9NKHp!V@gQi>ec>v@pS) z&O!5`utY0`Cc0B&qD6G4_n^HCEiK6+dQyE-E-g>;qMwQ^!a$i5aB)uK$G_fRHM)KIHPqI#6cbP;6=CEaTksnmoLKM+xx zXwWdLFjF(ibh?3Z5M>UxiovuK~ z&q%Bmv^)wMiS>cjIMO1l^d7XjQCO`}7EwU;qpXxT+MTXJE2N~+SRH6vM_a@MYKOKd z$DOisEMg)x=U6FYj63}Vt%NeiSm|46tz#@=GJOYacP`c_*CI-(B^Toxi}8)Mh-p+X z7URpq_@LQHmxu8|tH`s6>C^_TY#hcn&LS$vHV)&nVtmkMk->`bL0e+Ah&gl|+QNK{ zFW(|6sX8CyE5P`m&7-gaj1O94fkiB!_n_5{$N0uuL^aiq$M^~{K4^<5sSx9Xwzbeg z=|zXBb;1xzpWsV1C4;ECtSA0d;OagYyA`iDy9Mk?7bo`IpI+=Hw9WWd?v9W0;T)t> z{}k9pJ13@S_H?G1C4<>PKTdShzJU*rZu{qySOuH9sDEwq_u4uZ8&kvS;Uj<(-&TNA zJ}1e|0DrCF6HclJRsszGe+s4oX@ChZ13duzrscm2@tDH>!~y<5 zAP@w60GtEf1^DCb31BzS0z3&k1+>z=e+UZXZ%qE~90;TU8-TsbP~aN+Af~Ke4JU3p zums?wy%3lJ3{E&ce&e{z`X!}4e(n>S)ki@LFRZbKnL)$a9db- z$I^hYOf|B?f$Exdfy@=LO|7IWWd2FWpQ-p$3;*>__Op%k?f`%Av7KYN4)tDN$UXr3 zcoo9|jx_>)TnjHNy}VrS&TD(OY{iVx#pPzCqmTy*gZWq5Fo2m?D+?F}@KlThaI>!~ z&j;61!ycXl9s|o9F$Ty1#sbB_1fU4u9l<-p3giLffPA0;P$zT}Q^Kn1{Ceikqvm3|L3d-z_ykNqq&vz_Z; zS%n(M^*dr~oHwdBs2$*7#xFaic8DubJHs8hAK;34geosq?Cj%#E(Oq}yokJzF77B6 zK8OO>AGgx@75#W)VQp$x7>vCkV6WKKKYqHob%6!zZcn6#;U5eQo7KL2UhUSx2Gc}0 zQ5+Q!9T9_HYm`%G5RcOII)ia9qR@=}%HuoYpL*ZaQ^QeFkqA3X+v^N*Z^4fpX1{i& z!Z)CN*+=Y;jX+4pU$Fn|bFBZ!Q-`<16BiK~5hqDE=^E}-&uead{ZdlUz#hlokBNwl zh>4QaKf1SWF+aX6G9aAmjEsniiiixPlzIbR(s}hUc-_|5PZPuF2IPABu)(0|EGT`Y zK2ANaY27(AzGTUTO&X!p+i?`s{CQs9GdC{na(a$X<4S{&=!umvN;O9H9BD!PkEKf+ zhJWA;o)FTqEavILL`O-ITra*zK54A=QBR}PznuGu z%e3gB5RHo)ZF|VB$#kRh+w>Z59R;tB_E%4c4*B-*p0K)knXAB>CUTX@I-0p!AFm!M zDV9+a)E^)FaD|Lag^K*v$q`6D}5 zd{yh`^la!ttJdg^eE1fCeH?KAC~I_g1>t2zr5AWBmNq2hEz3J|?dVlqFZ-94bjA;0Hr!%0;o9?Q z$$Ep^_po!GrP1sC1b58fubxF-KKjjwB28PqMyMSh7eLohWlA8qZJ4TQ3Z&T^^l|FZ z=V-clL%S8gByh`~V%^5TjWdL|<%}YE+LN=Z@T0 zwD0`W864&q!V6TnF-DxACpN}tvU}498}&x@xbKx7cdZp~*JPt}5lQ@V!P}+VCWB2q zm%Oy(`kpVEQ%|EZq?jZ$x(6?=t{ACb_r6}Wy>n0cicPTa*p(wrY0W3^o;R#Hy3Xl& z4iWq=Tcl6<-nL@wRHp~|a+5)m--n*sq}P=9q0tZPHB0-@1!&ZVUf7~Hst1|#L%JW! zIC{`ugIpJliNSAr3ff{Yst1~<^Q7%xd7blf`ma(+vq9t1mlikc{nc~Px07zXlpgxW zOlMeZU)tNOk5>;+-!6!KAmjWyc=@R9s7I`iT{!c}hb^`pPS1+IbgNm9GlPb$2DRJD zARN8dI4W01rf7}<;x&Z+s}YLp=kbn8{QvP3{93qLv6wj zIvw*EF_4P3>1%#DXiqU>pkwF#a&J04zvUkFfcw>m6~nDlecn)>1pZQU^hDzzqk3fj z-TU)gCtNeddkRxpa8z(=aLoI(dYfUCdLXWzYHP&O#E3Y2j7h(Ix5E>S4}j>1#J~3p za6Gb(kHju+{JRcU-8S;uK9ug;9y$Irei`xew>&ZKq*&;2s~DMw^+jI~)rVYpeor}c zALu#jH_kj0P?)d;dN=4FUH|UTfM>s$zY02jd)Pm#dwJ@M{we=`P-!CKBwg9wuQ&fs zPUYmew%JwFY*l6RCMB!KUia|-&EVe{Dl5rzNB8~r?D(QHZEx#Lnp5`uA-lisO_!hc mryXsb$bNDe)t~bAi;cF*=Vjp?H-^WQ#zn`*CsA$5roRE=t&tW0 delta 9410 zcmeHNd017|-rnoTL5^||#PnW-Fv_O`<|!8^RD+dta+`y z&f0tNdSjdY+uGEd!#g|f?ahz%duFRCcu2~;rGKgVd*6sB=D&QW_`vMhJ9T-HkDZm2 zu(ZJ*RQ@jnxqLvH&icRasJ5QdH5T>NRSHve^}tC{)UE zcQ#;F!K~ROQzfYjbWh~#)>e}I!Br)dN=v6z6jh7iBRdxgORNTb4@ld|6@(Gm>sJv6jyhch3${#Y%sE}k;uPm4{rC`d;B0Y5ONC<|-3tUw&whH z+hEn-$7&c%fre!L6rCguRHVlt^;e|JkcP4(x=~|0t3IcVBxNX`Ly#1Y{>N5nJZel= zQolwm?XAL{WKXL|r)G@X49V>Q(k}eZcx*~0El|EFZ6gMn< zr?ae8I@~JpYEP#;Q;M4+aQ*d=hB{l)Dg|JXJ8e^1rQMJQE9tH)QeKx7H#`$gQ)R1k zSd(=3OmtDU==ra>DWL>39Ier$yAsCV{cWo%dGeLJ#ri*?S(U)X@tFF+Ga{MiZ z9e8GVcHQZt_6fRo{pg~O_C znnIKH>mZF#r1v4^D^mX+ct8|s4WtZ3x&SF%k%D__wwaJ7DYg@kCOW;nw7lhzoOzEz z%2d2w;k-(@-bt;}UPyx#+YLxbN@IIcOAo95Aa*@FUFwmnH}>I&jiowB3s^FA#+JsD z+D3U~M^Q^pt5`#FFRSicU)thj(RGfXi(VFCr|ez{bgq|YHSbm)03HzDMI{_8q+ozU zFu?w9fB-NUN?^tgC82{#V8(7Fp=pX8jZoMO)&nsBhkwG=tqudE6o3oD`cT5pnH!Mi zG%Jh^MzX0oGj||Q)&FyL*8e*)I&1n@72yGvD%A%4Cad-T`-K0lpx^1Q{>_%5K%V0& zfQNpb%Jab-{uy(+1&Y_n*p;PPfbA;*E^jr!Yw8gIp;{9Z=7jY?TVNBw`euLwGwY2i zZvk`ozc4po8^F9BkR-a_$6c8NR=M~c0K1z34$S;~>|q6gnfrAZ;PgiT4$QoCUt|S= znaeo}u>BaoftmBYs`B4?40u3}1Dx=b>Nu_P8P)zKxIJ(Y;K0o3F9BT92P%K0^2cBf z%v|9o0H^y*)jtPw_*|m5`gZ(dA5aG4Up>#9;P?3d*a!aD2mXKT0~aI9X-(b$s*5tw z$S9j=Lyb{(N{=?ukI?iqJlam*LE9H?6K&}(wB0dA%8RiH1MP{i)5KUK8DnjtJ!Qw* z$s^84FF`YsAk_ve-pW+Jm?k39DU%Q#Rt> z^bF!YWJp7=($J4I8xFHapdE%5IKU?QQON+ih@@kPqevcT7tu5aaSWYA97`dC>>`d9 zAdaW=h!ZG$uw5il4dNtfLEN9BhS)_itwfwcA0bYqq@i|Up$5cOx{5fB1`Mm>=Brs5ttEZHZs`I6B~MB zvx$*(1lnO}ff+V2no2S-KN*-2XjvqW#QcoJjEuD57=9Ak31|_cY+^hu7=`&6g&Bcn zr|{93pV3CD8*LNW)B^1SwA4(S$fcE;n4L__4zxT<%Cb{pmXVsWY+^E9h4uxskz;J4 zfEvfxY4aGYIB115d@SZ@EaqseO%%~xXx~B08)p;6v}YXpHxB(9ZxbbyJs$lVkN!b> zhzt|ZzX|By1e++OBhU^*3$)wBY$~y%e|Gc_+8mN6qJI<7zlkZNfVx(K{k9_EocZ{9t>JHN;0_m}pIfAizJQ@UQN z@};+PPf%QvjlP)VNo$hQmG1;K)G%o@kw-6lOK>xWW9b`k#E%AhQ%!!C{grthLO5t~ zzFof)$9FFn`*2c&_EoTfd?x!V7VW#Bd4Iv=VxeDz4?OLWeAxc_;!NHCsfC-{D0OI` zP~35n=Q@T_eO@LlDvsK}sMuj@FQwI>a)fa;)Yg$22<|c$9YyK9+n6@VRRzz~@aqqBQ}0M&$G28lVnX3-Gx!4Hy6n1O@?q zKmfoE!5gP?#AyaU3Oo+%2Ig@xK3g^b>i`1Q0~>&iR8%uoo&%{Ir~p!cRKNn*=zLAW zkQ_+4z$5@4kd&91Sa2MW1Ox-2Kp4Phu@8aw06sA81)c<+qLE93dOrv0AaDraQ|%_8 zA7BOebo=x&LdgJ*37OM(1lj@o=7zeed9^7HJ_hsaAtz#JGM`GhAhv0R;A0MdwB#>{ z%5fQ=Zxlb<_&C5zz!zXUr{yxVyu3tssj#mLr|t`Z6Z1UF^vp7UdgWm^eIG?@S!TuV zFF%|c!jm!-;BjCc2H1d60FS{)%mjGt%>w2El>o0p zUXu?2Wx#A;1~47qJe-&Fv7cpTwsRRQYtYhh`OdV}u8dj+tpS{v@#{uu4dMc{#&AOx z09-KlP~(NFoqgQVB|r^;Y9$A=k%bkA5WIKLsO3HIYv0@?W&=_@Jh!GP zceQ1*hscjIN1J1m^vXwP?NhDJ&1~+cn17yM+rG5Vx5yu3#-AkpcFBwAqvf(#ML#T; z{rQ1J6CKx{*ct!SdzLObu0JXg1w2muR>*Nj;O_|kSJz5A1Xx1OFQ6+Ge?@^@R~-8k@E)p?UD2Tx344x_38XN{4wTOb4-+U7amV|_HDC1u{1I; zg3F9FM@5+<^>liLEM)q0MGQ_Ya&0lr9yPTwqKsy*l65yEI#+9o(=LqmH4lz2Sp4B; zolwhdy^CtRIez@#Zhf-L<=I7nD`gCP!pa!67=P^|YhL`lq9v<`z3)mqmUgVvYEx6= zJm9j4T@DDS)9HP86T7gcd>gYlht7DvQH7ge_ zyUO%l6YZ~Eh*hjizklF~Zi{%hFwjxhRk>VzH=nnr##j5|uYIrYB+gL#x)9y9wq&kz z=*m6lR9&>L+Jo-bnc}sptLJ{Ye!HFDsqSt9bDGFSYL{DCTW;J)+j;)J%k#DeWvn&% zYqw$hySwE@e(`5tSAvdIy;hFbZqHUf^5eEcVLsPfe(iqkyZpu_vD;4ll?pZS9hDZ0e zTz>5euh#9U>63l>&v$vUsI*>=*RK3dw9VW!^o!D0U4HFS(DeQHQDaWU7r8uZeCWk` zQ-F4h_};Ql+xy_X-mtJm=oRnAC8}R%!rRfFbv0;B zAKVgXmzVP4?R%`vy>4|9`3cyd5E5xJ$#DbyotK?gyFQrf)gd?)esy=wP(8_6DcA3W zS8`4~K^!K~K9U0p;O~G%IjTB0>8aF)Mew7g9LoIZ3Pnc@4RBs_{-apGx6$v+#ZDp_ z7Tz?q+xR*0KU`n-+1CfXMGg&E9}=M5sGcjDd7^FdKVHxYb?20J1<;c9rU30`bz0UN zJ<2jl(q)av+JkD-3nArDvlTJx6e*3EG|}elSmx6aGvD4S7mq)n;-f? zK6_%7jmDEkZs6Usctecta#z~6VVb{orCL7fnMu!F{%blCM?3o#K!F=$@E)19F(yE} zuZ-56N&j1h*&EF@Cn-N}$3to7MpHT;?7UFtXUp2pUli*Yz?*Qq8I6&&JJ?Sa-`IP* zG38BEfITV+dsMqH=g)`V1KoXU!p5HIB)$t>x5*Ut9gd{@Q`H%M{z+YEO8&lN#kgtg zcY1;-d6OKVU9#5AT~vC#eB})tHos_e6yGDmsBDu-cR7rn-eS^y9Y)@bCcN)gZ{=U> zhDI6hwYN6OB7@p*mUV^Q=#8x=-NJ5^w%Mdx-;F+OGzDlEzHev8{yF{fJNO0C%0AhR z)^0ZWYgfos&u9E}rhKSyC2*%>C{?XnZHco9YT-K7=&VXj>1>#mLUpP1i$a|J&=UT_ zr5T-dt0n%t_gc+ruHPP?UyRIuI3&2k<&LlIO_|$F)!GetRmcOcr@wYMz+3F??VRpk zF9?_C_vF!T(2tu}46{%3eM4QD{376NiP|8HMo^O+r`@Y-x8j@}f7mFrn|1A8Tql+! zn&WVUl0Kl)CRx`mf}XB3b^GF~V)`m^9&IRTsTv9ihD>v@G(EGscs_W44*5UY{+GEp> z1|HN>0io)`evdaB8 zx8H8NzvM69hIvgv3hlUQE+n5FfwHFdi)i&kD92Bl(;Q5e7v0HmdMRDq<)EFfv?bk{ Kj#QJk`F{b3_20k% diff --git a/example/package.json b/example/package.json index 6f3e8a7..fc97921 100644 --- a/example/package.json +++ b/example/package.json @@ -1,20 +1,18 @@ { - "description": "📝 Soothing pastel theme for VitePress", "author": "willow <42willow@pm.me>", - "license": "MIT", - "scripts": { - "build": "vitepress build", - "dev": "vitepress dev", - "preview": "vitepress preview" - }, "devDependencies": { + "@catppuccin/vitepress": "github:42willow/vitepress", "@types/bun": "latest", "vitepress": "^1.2.3" }, "peerDependencies": { "typescript": "^5.0.0" }, - "dependencies": { - "@catppuccin/vitepress": "../" + "description": "📝 Soothing pastel theme for VitePress", + "license": "MIT", + "scripts": { + "build": "vitepress build", + "dev": "vitepress dev", + "preview": "vitepress preview" } } diff --git a/example/src/install.md b/example/src/install.md index 5fbd7c9..5d8ccd4 100644 --- a/example/src/install.md +++ b/example/src/install.md @@ -4,16 +4,16 @@ ::: code-group ```bash [npm] - npm install 42willow/vitepress#main + npm install 42willow/vitepress ``` ```bash [Yarn] - yarn add 42willow/vitepress#main + yarn add git+https://github.com/42willow/vitepress.git ``` ```bash [pnpm] - pnpm add 42willow/vitepress#main + pnpm add github:42willow/vitepress ``` ```bash [Bun] - bun add 42willow/vitepress#main + bun add github:42willow/vitepress ``` :::