From 1865858230c3a8528741ffcfda2ff503f1134980 Mon Sep 17 00:00:00 2001 From: Wilson Silva Date: Sat, 16 Sep 2023 15:30:41 +0700 Subject: [PATCH] Add the VitePress documentation scaffold --- docs/.gitignore | 4 ++ docs/.vitepress/config.mjs | 28 ++++++++++++ docs/api-examples.md | 49 +++++++++++++++++++++ docs/bun.lockb | Bin 0 -> 36013 bytes docs/index.md | 25 +++++++++++ docs/markdown-examples.md | 85 +++++++++++++++++++++++++++++++++++++ docs/package.json | 10 +++++ 7 files changed, 201 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/.vitepress/config.mjs create mode 100644 docs/api-examples.md create mode 100755 docs/bun.lockb create mode 100644 docs/index.md create mode 100644 docs/markdown-examples.md create mode 100644 docs/package.json diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..454b965 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,4 @@ +/node_modules/ +.vitepress/dist +.vitepress/temp +.vitepress/cache diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs new file mode 100644 index 0000000..8cc53aa --- /dev/null +++ b/docs/.vitepress/config.mjs @@ -0,0 +1,28 @@ +import { defineConfig } from 'vitepress' + +// https://vitepress.dev/reference/site-config +export default defineConfig({ + title: "Nostr", + description: "Ruby gem documentation", + themeConfig: { + // https://vitepress.dev/reference/default-theme-config + nav: [ + { text: 'Home', link: '/' }, + { text: 'Examples', link: '/markdown-examples' } + ], + + sidebar: [ + { + text: 'Examples', + items: [ + { text: 'Markdown Examples', link: '/markdown-examples' }, + { text: 'Runtime API Examples', link: '/api-examples' } + ] + } + ], + + socialLinks: [ + { icon: 'github', link: 'https://github.com/vuejs/vitepress' } + ] + } +}) diff --git a/docs/api-examples.md b/docs/api-examples.md new file mode 100644 index 0000000..6bd8bb5 --- /dev/null +++ b/docs/api-examples.md @@ -0,0 +1,49 @@ +--- +outline: deep +--- + +# Runtime API Examples + +This page demonstrates usage of some of the runtime APIs provided by VitePress. + +The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files: + +```md + + +## Results + +### Theme Data +
{{ theme }}
+ +### Page Data +
{{ page }}
+ +### Page Frontmatter +
{{ frontmatter }}
+``` + + + +## Results + +### Theme Data +
{{ theme }}
+ +### Page Data +
{{ page }}
+ +### Page Frontmatter +
{{ frontmatter }}
+ +## More + +Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata). diff --git a/docs/bun.lockb b/docs/bun.lockb new file mode 100755 index 0000000000000000000000000000000000000000..128ea5ecd39419b0e4ef33729c62e9ef94c70d3d GIT binary patch literal 36013 zcmeHw2|UzK`2S*+qY%0g5jw0hM$B?IO`3U6P7Y>2Q{G=ukpZsdOkQ z72Oo6kS-lM{h!(0+5O}jiQoVA|NURD=KFn`oq6VY&oj>)pPBi5%&4kphp<`N9`rzM zT41QMM@XOqkQRgK>F-Tv(6qdntN?1TR;Z4IFo{IkG$naKd`^jth2eGf)A8G*pQfC# zQ(iIHc~`Po!}S-(rYpumB5*Ug9!ac?AIS?xxbS}b;)#<;k)a_pPMn$$i6jr<72x*) z|2@PaUkTKZ1wS7A-r%p~`7eMk3E_pjupCb=h{+E2WV1;QWD-dN_<__wCfy6tLbw-% z`-_rDgTa3&LC9}11iHwS!F zenF8E5|r+^RtN3!7`l+K*zJA*$2!o$EvI8xxl|B;^{5o8g08hkbIXM;XSZ#iCg ztRffx3uHD3;-w)IE$|^3$E^%mo-}8jx!VH6Z?9H7Z_eHRcE*e&@1E^_o4wG*O}6Ba z{g`upI}MVj2o?MYpI^Mxb7aMCR=NMNx#yQTJY`m&n*Z}-k;#ye{VqvQuzn~#w#oQV znw24S$&o@H=hkI-5rs>eaqNlaJ2QB-3SV#J`5+$3^vD z^*Xw0D&wK8bcSWTjOy443wt)_8QPcTrftdz7wcm_GG8d6^vb8mA&d9S*nF-oexF=_ zo6nm~U#a@7-w_>6&hmBZGbZfC*5LPP<3648==WV*dWifdhI@KzW&BCY5we>4LhEYN z%F|>Ni#6*V4_edbvBqiaO5eZK@3q*lTMt)wTkCFpaE^Y`Y@b1ofam8)uWi)pg)Msb zx2jJ*9C}%2{0_Ig9@4_egLMjS*L%7S`1)0M`c*^Pbn}}d6%_kqUg(KxRon%9Ocyj0ric9)iHzsPiH z`4fG!f%(b%$E9h$6Z?`CIr#Lk`1^h;oa~R%gl*^gH+f-&*|Rqbk(ke6c;z_g zLnI662W|0Ko)leu;2kx+vj6j~%tTIN!arF4B*alb9)?{KA{dT4<*>XlWNg)k z*bVvn-IUjXg4lE;|74IK5AxXl*e-uEB2M>&Cy&F}@2vb#s5Fyq=pO{~V?n+rWC%ko z8uL5lu%3rNzB~2T9~zty{*#uO~_(Iq~!dDD>>_l*96?Kz;^6e}vH)hvgrD{Df}E zQ@~(`Jb6?H823*);B;Of-<|f85Aw+Vxc>gO{A6hOIv|ha5W#e>Qx5BI2lB=skHT1o z&H!NfO&~uS^7E67jjhW%||QPG|J<3QfA8~Im*e0TI8 z1&f>R)E^t?n8_0LZepMiE*Nyrg4iC)kl%ECi-6{Xs zZssor6E2vibH-mV1qnTaI^*#89S-u=Adluxf8(%x5y;zuJbHHb{0jgqF9w?j79fwF zUpTHaFgUF($WP_vk90uP8HeQ)K_1QjU>eYAS%i<}?|?j>f5K4MX$&kc2@g$_KeC-D z0T+ID=&-yE$fNlK(jUilD9B^tw97yqwSRbwkx<+DTl@LL<`h~#AXwD?kRF|JIR6Te zN9%{K<}V8q7L3gK&qD1F z^`EY^pVc6b=HJMENcX?3|3Z*Q_1D$>!(q`l0pwBJ15OTeKXLTe043MAO4S6BhOm*mnyd%hW$9_AzDgOfG=XXQ@iSW{) zJMCv1$alwnbs&$Pe_d@qqZLRb-)_h!fjk<2yW0ONLEZ=C(YPZHgm60JaQ~;lqIYID z2#$S=5F6Q5jL05utelEJHZsHyVSH4bWJK%82&VkPpKQ3Dq%}i{m=- z(O9kygm8v)Qvd3sJV)^2k&m7m+CV719uRWKNBJ56q4coFz|qqJeB>;EP`o7&(h=%_ zKMs5(w;2fGZ{dX#!AJV+;)PSdM{=n=KMj23kdNf|03rFk zJbxe02ah9%WdF6>|2OUaU%Tx}yZtHs6E)iZVJAf5;u4|B4k4@%k?nHJMxKZ`9T~Lq zm1UCAl-emJiE&0$i37Tg4Q|7uhn9RfabQZqwW8U6_e(#E*83kG^2MB9ZMAq@>+BZL z5#yphh#h%`*-DQk?+e!?-ua$0dv6c#i!W|0J~@3sdLwnW^W-Bko^=h2=ZrbJEx>8B zrMuOz$&n?a)gII=Qaj<}p1i%(yU`ASFfQuj*pVmfyC7{4`gm3}^YELm&7-CEH=TNV zCqiB!+aqmNk9?uN?BeH!ibqdb_B|UVE+SfG>C_loc`QZ_;O>>{3L@nw_dj<-BWhFEH-}jxv+*Y*;cJl?;Z^uU-SZiFfMVuN@g8A*6ZQ@ z27`yoTC-ckdfk&~%uLIdHhfsFl)pix@b>a@-47mpL!uidC%Ehlrzs8|FRM9TC+wT| zQ^Sg&q>2;I3An_)5VFn0H_j<81?Ow_>#U4+->a+~yLYB=T&#}GJZ}@_AL2@ZEvxQ@ zj#LV>+a^9$)h=28ptxjEv(I)1sj%cj(@&(K=L^;sJtMFqPyC|x{pzw_XG&a*@=m#l z7SGu|-ub$XUx8(_td3Gqq4I*yPSzVgJ*cusxqfI!eZ>T()V(eJTX&6l@j79o*r>Qx z0K&Lv?t>lq)yu~V+_Wd0QCc_F$*b`GxTv6gWo{x>5{<)~#!_ZK-0?%fbhVM;>QKqI z!($5UYITd|$@NuGdSP?Lrg=cpe#LkI!nkNIf*tv*NcD(T`PnrwVF`CGzFyMOFnGq* zdkR+Pk3OR{PE(&eDfOx^#l!J#T|va4I3}Emu8)Wv zJacb4)qaqQuI-)iq34d+`?*CFk9aY+W@OEjR|@JIT-RUT_2QMH1^{8)-WU{oa>e)5 z!z-^PL=-d{=hnN*Nww-(i|6#cti-yewYyd&J4xg_d|FXbC|9I9=eTp-3@7U<>x+5Y zpQi?@pIvh$R}IYtFfN)aU`HnVjLkGvy2 zq<8KFAdCy!g?vX2n|H8SEihsHHbnyusiW`f8%n8u>n}vz2$7bzkWwjlEQ%i;=T)6H%w>!e$ASQle4B5ZHV)c7*`XX zsVe8amb}7wbgyT$p3N$8#+R1mESVRe5;^J2w+D|NmldY%TO#|$B9?6N)zyuFE6djw z>P^^uj(yVW=jRyHO8P_%?!Df*>0-iYQ`LSFXXeplq+@iKmCwyDp4>-L_`Tvn)hA=+ z`yLD1Qn)bk!;=*bG2iJok_fo4?ZtOw)ng~7H}xWae;~ilc-MxhO>+$Mnx4$271UlE z?&}u6qQLg!!_n_-HNMVy@>J!~b(_fvEE6sFnO8G!H9vX1OqoF(Cy9F~WSi#=#TUXe zJWrK+7#o*(pRO$n{;})xf-D86amR+*zG})Wc4lu(rfZ827k^>p`TVw?#G)PQizWMC z@m_!HtB_wIL0{PB;X86%&IRqB!98bPx_!a2fAFHi8IrlJ)y;~H##34LW-S^?O*t#c zQtp!b4s7!rzjR*D_2n6%@(Q!wvnDLNp;uU2w4Z>B)(+T_A9&wM@u-{bX)%c*D|Tn? zcgtL*XYmdpQ~WjP4b8$kx7hC6sjB}wgDX+PgIpAaK;miXr-#((b zIBI9;8Pp$xf=_-iNMy;f6z#kRLM9KQXd5%K1I`aAe{*85&ea17UIovz-V`bhP|6o= zQJl3ssik&~{l@KItEL#+~K_`TVZ^&O+OZ;IpDa{r>20nGv6q~Iv4a6 zBSnG_+YWq3cKvy?ht?J8ujM9V&1^|dc6nQB`hIG-IIkeJY)X@Tp{MHT$HlR)T9}1Z z5wd+6shgF@A6&fUs`jmm7Y&s+YaD(JNJ6kWi3DGPj|%k`QYmVauH_*y=-|2*buSrT zVUy!0>&xy|JP{jXnD0Rk=yRC8ZQnrUbDLf+ajrW!({+YH@71?V(ls`pv2t9pqsp9v zOA@mHAC~!iM~*YRXyqF0k#KW{Ys0jviBr~Y-MxW5Fr%t`8Tk(Ln&#A;v!%hO{hpe5 zty3`)PB~P!eUt9u+Wt8jP3t}^F#4gx?Z+fBWk5vVY+y%@*p^QnNwNIc!tSrPLi&!_ zd-Axf!OCZ|A|iCh-b~lcwiETw30HT}II&NrnhzCzRK0g5|%&D~@f=mpv@|{19V8xXO~N>frLS)VbCV{J8xsl7p*C#GS={ zzeuCc=#of7*3C_aBbN;;?{{Xx%g0$G#6@>g{i14Ho;)&)P_7FwntiU?+QV^i@A%Ue z>ulGWOdQ3s*(moJjk!>799%Ub?!wLU>7jF#QlziPo^%PRcKHdCkVJ`j*T5TDWott)hVlC z!l)K$&xc#S{g|+Ekj$$wLiehb(n=4!-8i!#J)(zluU?mbq|BYIf9J`Z@r%m}4y&9k zdVT$z`p-u0o`D!gUv&%$K6%`lLvthwh8E9vv>dG&VqAVav-I4{A*UbAPYLgLLr%r~ z_=kwX!AEjzgO7gFO3(JY@F4Wvg99cdlOrX1x;Zl<>;VJyW7Hnd+y^`I{nf96+!C~N z;)JFTPx8N4bR&;aq9^6~G-3%|?(Bm!eNoM#@*tBl`_|oE_G$ka4lYRybvQH!#EzUR8gKS3F8gtL zV!t52>@A83+IdFBnO8D;L5oJ200oV**p zap2LNQuR`y=MIhN|4w>t$?&lA;ulRfybd-!t|XMAP&4_~unW;@)M;O{Lhq{fnh`s6 z{P)cz99%MJOd^dU;xgrJ=4|ijv`pWQ?r7h9?3CK`FWSjz$L}QRdj-c25xP4o(q`DU zSTDz-a~~h)+%9UGaxx-+YwEp-mCq_Iyv47h`a=4mf3%3WZ`~hnsVxyH`da2PYnWSY za*oBi17*>bQIhZHZn;?BvnIOW^Esm!9m+j@Pw!Wk7Kb-x)M_a1>Ge@P$#mNL^tkC9 zT+kM9DMVZ&^O3_Ys|+x;8a+=*C!@E2`p1W6pGsx!77S>0F%D_gJPw;ws1hCgga{F5z&E8P0=Ou z#hc@;{1SaXKB6Q^WU6_|KHe4`5ol|Z_bqr<>v7ZS=JN$2g(9wFcAq4!yLE`TDnaov zNzoJZjuuN?H#{`GrM^Y8S@Lmg=DS_5TIJnYB3p-^)yRp;Q_iZD|6F_R=d-*@`}H?g z4ZYi-DC7R_%%Ra7eYyJ&sLf$VCb`svM}70(RJy;UtiOZmx`z6BneHZw?jM&Q+4}W+ z)%Y7na%;xr?yZt$2kf==?Q>MLZ}Q}?y`0*ohF}f z*&Y3*uK$=I0$kWfGRt#PHD!%4+jK1=I?}hogN{`B!R|&Yt z*4UBF9$EZYHr&;5bIk6C$D#%dv5b3Wd}`;RPmN!KoId35a5XOSQVd=*u<%3<^H^&c+i5;+kqS+#+*&w8**aDA;rAb?g27 zle_X-JcSltE4_Qhr^ddY(b#$S*XA|G4o((Rh##|adF-)^;`0y7*;#6 zdT?5j!R=MXnj^<$j}dsF{I;FySRRjSS-XZZF`J{~Fl|Z{o(IF!5 zmj*_sr+)Y>lT9+4Y@BzoK<|v6eY%Wj-PyjEUZqz~F+ZdB>DAB2LTX1#Qnt{2?H&oI zjIigkK4`a>47Ug9}?##5*4>FV3_qhIL_#u0h z`0q5vICYoL{+UaD%5N!7`&RG0Z}j@dn?}?E7Pf;a5%;V)l_6rhulKNC`*$5-`USxhtdR_-qD|SucBvMMtgi1 z*NliOWqD=sc}?3$Pd)Oq)3>xQmF`UIH#KqXzQu(b6i5wgU2eJzcYHU)MoMPp{T=&; z-cCK0=i-00fAsxZK`$IB{jKH`aK{pH?`xR3z1(uWF?K-sS5x1XsMh97A9@UUPM)%= zn7y8QOMRxwz;eb`>+KtFj=Rh(%TU_Vs=Z?JvMUxQE^#YQ)$R8t;F=S0Yf_jChGz?9 zWxru$zOjATFRJC~4SUlc=4+=3sfbop{Ybm78F_TP=J!D6%jXwen_aI zKFfiNM4GwJd2YR-HisQ~_pKDs=gSj^X56*QGFmgzDXH4y=7}TuCFjaxVn2MUdED|o z``z-dvv13Op3i)uWv#)UESGt{Xh)$#SmEJ@%4hch2;0{JgMv@abP=^zuHNc6G%QSX z*qY~8g1pvE{d%`bKd4@lZ@RfJ8Yt?jx#cr-&r=*^%~$Czu<~BAdUo&}P4$N=s>uXgw5G+5 ze66mhtV!9>2feRZ-!rY-ns{P)!grC_w8{ogo2-@`L%XyLkqvzco}CkFJukefSAN8S z>ATCKlGhHVWxNtG)6J~{Agr$y1_hr?xsqNPztvb+mT7eCWb482o=*$e(u%5$_M_Ja z#g@rAudWav!}P63FGN}Oy(v|u?ve7u@=6u=aRQ>S>Bz zQ}w~CLL~|>jqNiXEK=sHxoi}zh#A7%6TL0NXi}Q~`}kaoCrkD|>Q#5+_`t@uDg<0x zB5vCG@Rw(DNb;Me^zjj6k-azDoISAlQc;lFglg)ZlLB;vbk-=dG@uuP2tZ`iohM+hD(WUuwb@w94(9@*Vw23EvKriMaNQYzG9me|IjZ z9xHo7V#O-+oqJCxl**c&XWf3Z<;Y^P2yLlj{oB;0@-us4?(~SeqTsI|H91i>P1rX* zEBMxisRUd!r^1e0)@#JBYfoq8(M$K#FO2AsSmOWmM!H?zu`Ai>zOO?{4P6G543And zW5*n?>ot^1tV#t@iP?cFy_Wa=VpK`?U46R|XBaaJ7)h!=&{PCj9dJUc8q#xgh zD)zZrXqw-9rN4N;<%cg{ypS!UwDxD8oasAP4$an{LVYyH&OwdU?CbZ@I#(fOKLFwO zFa?8xPd2JPe%a2&L{gH?${*`IVdlAnu$m%I+x*&ijW@R&t4A;Y8hC1EeQUFn#D%FR zDK3|L>CL?=*K4S2a+%U{S%-HpJ>}y%5OHN%P(Z*%YYptk1H4{p zNj9F}@L*?bMSQ}G;fFu%?H{-3RqNe@@>ZkwHfbEY@$^pdzC3bSN^aj7V=aYN-wHnT zYD;d-Y2lNZzWYPU0SMax)gg9dSElRc_k-v~1LslHdoDZB|9w=N^YWQ{*F`R0C3{Cp zL+njsv~gJTpgqs56Gt6RPzhR6`@l+aF5R#+D1PagHRA#S2;)w}px~1WUOre=6!64s zUcUSr>LaPDA~&TPruy2Ul0lAlYfqK83`?9ceYNHHty>zr`t7PLxbtZCb?UHDHJg4U z^miKm%n{8+FfJN{up`^HtWeB|vD^`4<3Ch-e4LZ`^xXHPUG^~zH^~naw-&?{o_xdD zY)mV09v$+i?BdcrtH!?|313({q$XQsVPM3rXaK^vP8bw?^1_&myuIpK#|K=i@~P8V z^iXn&)R~o$!qP*o&pY$2^4+Avvj^zPRvH*2ZanYy^z){G!T!&!ZWuhdE@CGlJbF7D zjky@tnTYGU=(OBwrTT&4*#-?8V)shdFP1XctaR>Sn)9rzedN4i)2WM2C#`N+SzS}! z;_TkLjAZ$3mb7k_QGK$9ch#{YbOP=SBJOQRn~-m*Iqpf4QS;_mSEvoQxOGT>O`u*$ z?TeO-9-G5&ydEdo=gsrFm~l4_yQl2G@#BKghwt>V^n=<*$1MK2kvN}pA>#Uf-#pz$ z>c`w;E!(OS#c$6pXlZ?{plxO@ruA@QzR%QxR+;NV20Sdi8!j_p{*VWLlDZcsT8Kz7&Y}4ga^fWTJ7n->z(--^{fqxeGXMukf_-BEC7Wij@ ze-`*>fqxeGXMukf_`hI*BHkYU9iA^?#)i`a>4EHEDuY46C(u%ySu~otvYw7In;uSM zdXG{zP^L2IK7mYc37%3vTe%JeIas_uCY?2ln?S-WL|@Mw^mq2=>r9fBOmV6F7gz83O)7AWNX}KCSC z1|5LVJ2&)x486-j@14*)BJ@57y?a6SPzTZg(gf-cqywZ2gua0d!&{CjfK#@Spfuev`0IdXC1+*Gy4G?-qwH63{pEVqXdA8RD>=V7zot~swY_>R4=IRP#mg1A|J)|07CVLexv&A$qS=+gn?xG z0AW778{pIxN{8wS)fxJY>I>l@IbvG$TOLS`7vGoX4+J08`2ZkfcV097t%vy9KolS? zpiw|0fkprg2SRnH0i+Hz3`h+K)z?rU6(D6GRF_IX=z9WGw}XKO0T}?HdeH+y^^V#i zvM>4;X$%liA!Ki2xV_)V#z@v22z?`jvBtx1OCZ$tP&-6*IsvFH4r;45K&aiK_KVsv zZqulJTLYoCJ_%?dkS&lE5RySW6o(0gkt_W^?om=Y<%<2xZ70Uvz&Rp`d+4;&Xzfdefy5}!f~97B+Sj=uvb~OT?$F<5R1F19go!zt0CMe02M|wO`WqEsD=& z$LCxNO4`14+Aj}2^&Ow04dv0H=<7i9#plH1bGLy5O`f8w(}4}}J8*n9H^`ty3Xdy% z+B`nJn`bxZCGA@jpG1#O_U6by2OixeTmR2mr+qYhK0ZEgTu?vw1buuWImbGjF{FJo ze9AsPwOoMKz6^eYk54j(e4rUZ<>~ykP7Nq}M*J@U@G0mV-SmuLfWznd<8#uX65J)4m;=*b;>m*$7CuNYV8$)jEZeNKnOrgCMbzZf6W zC*C(qAOp7xFhT%tTryQ(%6wH3ffM3GWr5hq>z;Scie5P^-~`iHY#NJ1dKcx|nyD&e z3HgkMaTHpW1!#aq%Xn?q_39_an#c&5k5$%%VYGwt;2Qw&iRxq_j@k5dNcfHbeCE1< zgKrVQr?Lw;_?`iLZo7bkZz8}ay9+q@t^$1ayMTjlGr*_A3pn_`1AKnGfP-&Dz$eTL zI7Kk&lLPDEGw1~ze5(RJrCz|n_b%Xb>;)V&^+V57eA2yugYRy@XW;3&iG3-}yvRS}sJFgOOyhGSDbbH1pEn4|2X5(`K z=PBfa=3);jrNYx)E-e;t8hM<0CHFZ}(#m56oR7dkbIXG&H^R&h`_crQ1uRdd7Y)X& z(<1Cz>pN-!&QBhi=`^!fpN0p&6L7?!i^u@l)HO!y66f#OBH#=F4y=hH9hS{8$r>BK zScX6H9RUvN3!i;N4{RS)`ani#55%C6=)W_e3&4TQ`8S08w-)f-Ao#8YsBLHk6kQ_{ zzC8rr#vrKEuGBWZV+7yXfSxj(i8l$~LV|B~Ky4JMphLpi%&K5yfh8%d z#v<{}3j)r6XZScDe7gz0Edug^C%p+ge|XoRkm6q4s~Q+roFFe`1^CErF5siuju>G2 zmA=N=TflJx4yvCo4@1cFn#>L5IitU_nX-N$aL}q?P~TyFma96I%J9+feJA+-2w@?3 zFmn3bQ;>lbY$U#^LcqayrQo|K1RQ*u3cj5}z`^&e;QK2C9DFkizUe~1!FRRbyDtPB ze5(t-B}2f$_rl5L`z@q>4!)TP-}E9F zciL(oBQzVfgwQz9cH9wgx*~(`Lc({;2sCJ4xAr-0M=|ak7L8(Wd3!B70WjQx`*ow3 zO$!L6u_zP6V0s)#WjF=H7-PbAj0QY~kR>8MS`AQX$UC49Vfa6C+LmpB zHx=g?SwjGgr8Td=oEnkyK6D0zVL*(06MfG6jDqP!cb*P?W3eu1??<=2tsl%&GZamYX!5YK>_qYIv2Gg{Qw>`gPXoMdomntP?l_8DvRdD$=#C~5Cqr9v9!FH z0h|a{NMJBM0PY6kh4~5C-kzKUu(E+_)MC*By=W{NtAp%+mmKtI1JFh{L4NE%ViVH> zFfk}V{gZ-xDJU@!1cCyPUu}h|r_-<~F%cJq3BYhE8;zkI1S?6fCbTaaO=}^Q;SVcF zW(doZrWHU9((14g{*n%vmng?+jC!czJJ9!+Yyshyuoh>B=?@6pn&z}BqyguLpo|pG zt%aO|YHI)z3H0K}j`EsoNhX&fE;`y$k>P!D4T z1Wfw#N9 z!GX|A(1Q)#!pYVSgqG2PN_f`}pzu!^V2~~V=LOGK&QQVq`=1VAxCu~!IJbI&g`wMV zOw73-m3zf!2lBkFNC4pdf))=uk+7~pO&)WpfnF@QgH(&k3iw@|p}~J*!w7L+RMtXz zAQJv>Br%;g4EY{xPA-ImIF^`_K@SWG`$Zdm3_+3`N2luR@zvu-F__FipZ_Ebpa-!H z4QPxuiGzYX|C5wOXM2YJCzh>mq7&9eny7UkEf^J#7{v^t1-6Z2hXgX&zoY`|>Fc$z zA2;ro!f~SjzJvPatH)0aRnPxTto+V{ASL)HD9|++PW#~Fa6*3z#5Wzl@PGd;2%$~@ zh7kH&AVGZtjv(;2Fx)l^)e0#5-(3UYv`{__C)70{UI*Yq@xomL(dD}HQdpeOHlC>za}wU~i)A2>HWfXWL8)53z`%JzMGa=MKo`!n@mk*WFwV+>5QY^5 zpUqxK5BBu^B?UL?56cW59F&g_#p!6A)hy?m7Vg#>XGMnA^-MM$ZH=MbGx(?j?Y!wI zFJ7z+AI2C`bUNr1zuF1%#|_G|)z z7&KVpqMEh%EeGuj(}J~lJf6qhibdaY7*b$JhRtwzNeCw9<^@}c+yq+i(KK2!Ei>1XamKM4P-MJfMs%bCPOt2aKD8A5{uY)0E!s=OC&)# z`KJG+sQlP2d%r&20ImZrOw!@YnqQtjzoh2QsNkUppO8~@;hAXo*XnQ~ z+Ny!4YB>A9hULxMe$ke*%l?NF1u;T=(4H=L#=w7?|8@TD;Iu7gJIMrg=f2wh-}mqT E0cpu+jsO4v literal 0 HcmV?d00001 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..1554164 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,25 @@ +--- +# https://vitepress.dev/reference/default-theme-home-page +layout: home + +hero: + name: "Nostr" + text: "Ruby gem documentation" + tagline: My great project tagline + actions: + - theme: brand + text: Markdown Examples + link: /markdown-examples + - theme: alt + text: API Examples + link: /api-examples + +features: + - title: Feature A + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - title: Feature B + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - title: Feature C + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit +--- + diff --git a/docs/markdown-examples.md b/docs/markdown-examples.md new file mode 100644 index 0000000..8e55eb8 --- /dev/null +++ b/docs/markdown-examples.md @@ -0,0 +1,85 @@ +# Markdown Extension Examples + +This page demonstrates some of the built-in markdown extensions provided by VitePress. + +## Syntax Highlighting + +VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting: + +**Input** + +```` +```js{4} +export default { + data () { + return { + msg: 'Highlighted!' + } + } +} +``` +```` + +**Output** + +```js{4} +export default { + data () { + return { + msg: 'Highlighted!' + } + } +} +``` + +## Custom Containers + +**Input** + +```md +::: info +This is an info box. +::: + +::: tip +This is a tip. +::: + +::: warning +This is a warning. +::: + +::: danger +This is a dangerous warning. +::: + +::: details +This is a details block. +::: +``` + +**Output** + +::: info +This is an info box. +::: + +::: tip +This is a tip. +::: + +::: warning +This is a warning. +::: + +::: danger +This is a dangerous warning. +::: + +::: details +This is a details block. +::: + +## More + +Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown). diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 0000000..b57a0dd --- /dev/null +++ b/docs/package.json @@ -0,0 +1,10 @@ +{ + "scripts": { + "docs:dev": "vitepress dev", + "docs:build": "vitepress build", + "docs:preview": "vitepress preview" + }, + "devDependencies": { + "vitepress": "^1.0.0-rc.13" + } +} \ No newline at end of file