From f3e45c895d02d2739cc7380bb9f44a4e2ab92c1e Mon Sep 17 00:00:00 2001 From: snowy Date: Thu, 28 Mar 2024 09:38:46 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20vuepress=E6=9E=84=E5=BB=BA=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 5 +- docs/.vuepress/config.ts | 22 ++-- docs/.vuepress/navbar.ts | 3 +- docs/.vuepress/public/favicon.ico | Bin 67646 -> 67646 bytes docs/.vuepress/sidebar.ts | 18 ++- docs/.vuepress/theme.js | 187 ++++++++++++++++++++++++++++++ docs/.vuepress/theme.ts | 187 ------------------------------ docs/README.md | 4 +- docs/demo/README.md | 2 +- docs/demo/layout.md | 5 +- docs/demo/page.md | 2 +- docs/deployment/README.md | 6 + docs/deployment/config.md | 9 ++ docs/deployment/install.md | 14 +++ docs/guide/README.md | 16 --- docs/guide/bar/README.md | 13 --- docs/guide/bar/baz.md | 6 - docs/guide/foo/README.md | 13 --- docs/guide/foo/ray.md | 6 - docs/usage/README.md | 6 + 20 files changed, 255 insertions(+), 269 deletions(-) create mode 100644 docs/.vuepress/theme.js delete mode 100644 docs/.vuepress/theme.ts create mode 100644 docs/deployment/README.md create mode 100644 docs/deployment/config.md create mode 100644 docs/deployment/install.md delete mode 100644 docs/guide/README.md delete mode 100644 docs/guide/bar/README.md delete mode 100644 docs/guide/bar/baz.md delete mode 100644 docs/guide/foo/README.md delete mode 100644 docs/guide/foo/ray.md create mode 100644 docs/usage/README.md diff --git a/.gitignore b/.gitignore index c9cecaa8..c1d2cdfd 100644 --- a/.gitignore +++ b/.gitignore @@ -23,4 +23,7 @@ main.exe main.cmdY docs/.vuepress/.cache/ docs/.vuepress/.temp/ -docs/.vuepress/dist/ \ No newline at end of file +docs/.vuepress/dist/ +package.json +pnpm-lock.yaml +tsconfig.json \ No newline at end of file diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts index 2767b9a4..f1677e1d 100644 --- a/docs/.vuepress/config.ts +++ b/docs/.vuepress/config.ts @@ -1,15 +1,21 @@ -import { defineUserConfig } from "vuepress"; +import {defineUserConfig} from "vuepress"; import theme from "./theme.js"; export default defineUserConfig({ - base: "/", + base: "/", - lang: "zh-CN", - title: "LiteyukiBot", - description: "vuepress-theme-hope 的文档演示", + lang: "zh-CN", + title: "LiteyukiBot", + description: "An OneBot Standard ChatBot", + head: [ +// 设置 favor.ico，.vuepress/public 下 + [ + 'link', {rel: 'icon', href: 'https://cdn.liteyuki.icu/favicon.ico'} + ] + ], - theme, + theme, - // 和 PWA 一起启用 - // shouldPrefetch: false, + // 和 PWA 一起启用 + // shouldPrefetch: false, }); diff --git a/docs/.vuepress/navbar.ts b/docs/.vuepress/navbar.ts index e79f59a1..0a0a9d28 100644 --- a/docs/.vuepress/navbar.ts +++ b/docs/.vuepress/navbar.ts @@ -2,5 +2,6 @@ import { navbar } from "vuepress-theme-hope"; export default navbar([ "/", - "/demo/", + "/deployment/", + "/usage/", ]); diff --git a/docs/.vuepress/public/favicon.ico b/docs/.vuepress/public/favicon.ico index b411f79ddd958612bceaae08e4fb10ad15340db2..73e9e36e9447447638891c806bf412cb332111a3 100644 GIT binary patch literal 67646 zcmeHQ$(9>M78R#9EPT3leOR(&>0Yy_FY15bTe=w<8ygHBFxXJo#x&hDX31ce$1-?V z=U~^Ua`cN#U1#Q%UdE7-N~shD&rkPF5%F%mlxk9qMz6_#@4PdTf8QLv_4;e0zm7(u zw?xEbjfLGlv>&(rQc8*Pzqtds1GxjM(}D4mo2HQMTV`Cyx1uXqoldOgNi+Ye#k<+Q z@wS!mlN&PkR?7M3F5n(;ynWkPF~8s5u)=W}FINXL|I5W!s@)zv{>E4tKPe@&F75-z zProx(Li2O{upP+!58MBFuYUCSYngW|n}wuaANK+1)b(?{ZXL+{ckAD>Wgk7dZc6z| zw8&)s`#uNe|M=;@<#j^-26-~VHdMVj7>LOW3B z-aZb^=lDAJ_HpK)J2Wgle0Wvn-O3k*q~49jKdyt+>%EkFKwVPTKWX(c|0j*n_VXM( zxME8AT(p&|g|uhId*?m>*lBeS_^;d#DuI7hb>@FHnLl`NS?1hIIsfzO!cgx`>0u>waigzHgkX4*TsrppZZQ zXI_f1f7x;7zn#I8#{d4-XQq(*7iI1*CcmCBzna#%&GDFLXe|$ZO>23vc6$#fJX9eWtb>c`Z=Lvpe#A%sYd>F39|s z-#<>xvsQ0t{`c;EEc0H8w$E6*YmQOZ73b^soo`nh_T?Lg_^#UC14=1>uAyr^SALy) z``8s9>UZ&mdagKMzl$$lKlbH{M_ejBFaG!Lo;Oxf?VIcP^2K?;zWE&I;!E>mUDjGW z+c_^4#`#j!L!Hcj`8*FE(HGY6yENye!u|1oPUipI!p=YU4}EZH7f)7Zs3{L`6fEQ`WF_5tlW9pYTtRfqkqdf-FTT+fBII&2TECpM-zPt9p@fvp3VZT-fcIJgK*K=Xc*KlYZS3LYf^N+r|H1-SaiiaQZu^M%t znV;CY$m4n%Mm)3@$9BYPI`gk}rnG~1=+OSQS09bIo`$)O7RPqZW84@2yLUe_R(L(e z=xbk^*9*nGuh9Ow*5i7qv1@&Neb^Nj>d*Z9bu2aCT+g+O%zt}_^8B~=NAu?S*E-X* z^Sq|U&DEw+Z}b1#S+grLz2a;O&si!wdo_P6?}PdAuQWT7>!rf8SDUulpB3!m=LIeI zng8j2vn3VZT!+`u@S^a~`{TKb#auTO^SZHp*4E{Eu~@6`vg7B)TydfP(D~>3-1k__ zbwe?)%lw4a<9MzYi@B~ZUR3_Ef9`)*jJm#>*JFNs>mZKvyJFOh)tUeH&Sn1F`=fbx ze>)?u|IT>7{@3bo|5IUYJ+||DJg*$DVa`j1we@`M{mp;ozs^A_zPV0)jhM%a#y`*7 zys*|gUf;L>95*klokO#~{6l_^SVZ&3+GFqk-0yi|?VP+m^Qh%<+`O>1AI-if{Bxg& z#^@LCgLy<8+lR*3mrLXK$X#)v{?Pg7J`as?Ufu`uia53pjj=D6?vMWu<@NuE-p?!C zXJ4$H&o@6bt}kA-bHuKv)nhx}SBULhvE@GV-~1hbHZHY(x8=0?w0dk`I{uA$Lw?Wq z4L*kpht9bc-`4XGpKHJD52|K|HUYrMlA%7YfK@uAtZI+|Up!}i|z|Mg#H zSA^HoF#4-$Eicxtt>dz5{dU=7_o?NjS}*fIpZV8#jI}R1|1V_rt;C*hUU{y0XTPiO z?4Q>;V%Nd@49Dhcd71zDzR!oogUg=z@Av-i>i^LG%zx(JUIVGG!xz7PAkY6Fc-Q6U zS;ndN$Mt>${%)n?rs4-J#5X^J{;;eE7z#8vi_>zI{R*=f`4K-+leq zm#;oNJUneBb$$H(G2eao#-*Nr=F4{d77W=Xt+QA-%q+dcj9|E|3Lf7knY zh3704Za=--%lqK@bXRDP;CiWW`>K^U^I!F1)}ze-tgg6i&t>+lxFWf~sj+K)m!J2; z^XbZW`MF+d>{|bL`?j&-iVO8;{{1?Zns2V>+C}ESy+e8a+xw$=^ZaX_Y1(;SQ{(1p z)2O%k|M{Qhxyba2O$*PLhMQTVkru~x&I`p{kNF9$$MIZG!>RJP&UpJaVOJ&2bH&5oAOHRS{-eeZ+i^~p<~$8^pEc}S4}LA5?TAmUGyi2r zHNM%-ylB{$CoP}tzV$-mR+WF|)fY1_zF6a>Yra<3*FN69C9nT)_3-+CvG4!Bd~=*H zUmU0L!EqYa^1Ism;vf5}&g1v_Ao6@Q^TQZ**dB|k^Td6h7Wvp0u%;20N{^r1G<8W; zSF2N%+0@a9-@ZbKWeDVr;xWVEOr% zzgYq9s*fIjW2}sy+$f}Ly{`G0|Mu5KC!K%3e(cW(m6GP?#koE(&#?<@c|7ZgW4j9@ zFSR~;{I$%xmCZs@*H2w9^Pje(%f>%W-}iOkJMY*JH0SYLBaSu4G3NNL_~_ABrjW_} zcda+?{LFv1jxRg^e0u!;Kh?s?v?OH~wjhps$n9)Wjg@D813m8weSzv@NI zBl|ap3JLuCbJ|++{g}TOGI>7&@P2S`aK(z2=W9QBa7E_465qTWH@gFw|Ji+6RV)4u zW$53d?W_cOw~mCXO#n!kVxfq&@KTioCJROa4FIsd8a=X%{b0N$ayRh!Pv z{7?5}kuA6mcJF>p z|HG1!SI-^D9T=no^1X1MkDc{q6yuvWn|{LMjqyf3fU#sZ3J@O4>N~XpjCXA9+7217 z+w8(vZi29Q?0H@lV7ylPH_K#W2-~CCd>oOn9Oll>`k$|kNLa$hYdh7e~kG&jNAKTKUHt*uRUCYj~Td?U%nm)yRNUIxAyv$9>-k2 zQ}aOc!t=z~&adoIolnPn^ZkIay=P4Loq2z;#@73j>;7i%{B8Hg;H=@ho-tA8-A`x=k` E55V}>761SM literal 67646 zcmeHQd2|)k9i9~2P{E~YwUt!;2bHQ662toPP*j4r6opzK2_Y;ZB0I>IkOW+7)hddX z#cFBm(yFLQ)Z@XU)mBe!Eww$z9*;q7ZR=9p5I3gZH*@E$^Jeay_aa$-kMl9_&YQXO zyWjV_ckb`bog2$4!oT`@3;%!D>bHN9b);ok{Q&IZPG>*A^4rsWEeCE|{uc&>0bxKG z5C((+VL%uV2801&Ko}4PgaKhd7!U@80bxKG5C((+VL%uV2801&Ko}4PgaKhd7!U@8 z0bxKG5C((+VL%uV2801&Ko}4PgaKhd7!U@80bxKG5C((+VL%uV2801&pyM#m*b=u= z(QzyjOUQuI=2&cFtDECi6Z9(NN9F&0Y;OhDX`wZ~uI|3_b+tb_eO=`_CF?3jXJI|| z)dJrD3TbY)%8S~p+8Uz|)B!I6^n-$O!2DFcf5g_-MswW0V)+mo`rFXh4{u`s0MS3X zTuPf$uzf@6vZ~<;x4n*@Yxb|${V`x8?`d5w~SV)t*d|pbE zG1z{Xp~-sm0rqL9e!v;H*83UP%k2-)zy7!7_Ke!Hpf=!1=zplR0s1Zr{#hS;1CRP> zu@n2w0rWG}IFk7RJpuLub8DXQThrrld&#=tcGXzlJ^JN4ru#8!y|Ef)||mXZNPSDf1KzaE{D>fFSgqQH2569 zRjXseGu1qT`8BnUqz|kFwDoVqePG$95%!b|OM`r%sd99wv;hHHC_Rg?ZPMWXMI7@T zo>RyV^8*-Xz6|L5KzKa(2I~K5(gx&KOL2c1wr^^3zXr$AUvg(^_)CMUKYd^dkn8@F z?H7y(e-*Q*UJ@7&ZiN2(iVtLqLJfiafz3cRzyA9;E^sQ4onan(m>@&+l_#p{yYvou;izK z@!)6BzKZ%!mUz%=Ximg?wcz;+Bd(LWJc;w@KY6O2eme65z6W^Y&su)Kc<|E82HTU* z&N(LV67)Y-+JMCKz2m^KS${jJJvCuGSOYlmTe^zTQ_Qci+38<4;=7ji&T(i1mi=sm zU421dJXnWkN8LIeboh1q@7Ead>#xP1kq5^Oq6_YGrm`_?JR;jS5D(5-8u)yW@!%=l zxeZX<4#f5?Ae%$;eQQ*G^-(g~E<1LMKlp#MJI(FYW# z>|fob&1pFI^rI5yUC0mf132E?0_f?_LdBrhm#9%X#2aKfcoA zeiQQC2PmWqcx`}LdJk3j!}yOR%48{lx@X+Xa|=^e}GgKj+d_!$NB z0pv-WIX-napl>sLVDZg?@!)P~UrGI|@O+@Fe|SGt^?y2ej2iES@&6R^J`5-*oy-py z1Q_*KoOp0nU_AId^gpUQv;m4k#(RGS!gP%KJN;@VuhrCAI3Hksjm;yAuw4u2+lDsa z$~yz&!9CD^MP~>tE@bMu033EP*(YG`6U&Mp67Yqp+ z6WReEIJqmg0n{HT1KtMo>rcdE8y<_V1)m3C9FB7^^FV2@s?j9}B9DVHX47Xv$-v&L z?v2$U*4(3A4zvL)?upqo;{(TpZoxHr0tLNqb%e~o6X)(nkN3czHrMnQ9FJ!)J8LJM z{tPtR22S(A(>VWG;5pzA$nOP=?fw1A^&`II{4Z_0VAH(DzlmoYG!|@a-3qYwhFM{>&L=_UeaVm#%N(IE{F4EA&68EBS!Zp7GwZ zfRT=@UyE-V?%X@+2S(?+Z9v%bSS`JwNA__QCHBJWhw1CD+NDJ|4701o_~hqagYn>G z>faT7KxxnVe>q?l?@>R@uby60W>=kCVlTx!Tch??@xA1h!1y~`S3j-&_Tk+hzW>2_ zKiX{oY+Ajw+`cq89{e4&Ke7wy&v@@|fN}kuzs9{^vb~)#&9J>y*K2q*ZeKPpF#gWV z2QFVS#719GyKMB~EAI%52fu>$izj#T=Y!B2&-dd!u)Qvd_A9sG`N@Qou~W3Si+*g_ z-l{fW`DV<|9jE%AqWN7xIm9i|W5+ZW$B+~)m*=W+~Z z*#;lrSwG$f)~^4KJ-D~6xEt{xd?&4pURmAkP0+tbXY>J-k=h>sY;nqK()NR!WgBzM zr-u*BT{+Z@Ywy~~mu+u*z@+Y{@-c69U_AI=Xg{R0>5uYx@!o~_{&8w~b-p|OBg~)j ztryV0=Au%2#m^(O0iGXplr8+xi3caA+~d;gKl>&30lhkt4=DYQ!1fs(y;F~2-DH~^ z5Fa^XsIwOgws{XtJ-1VShYu{g4s*uQ&w$2$_yqeerv9D52cUsh_ZQ&%S4Nt!K0JWu z0>_qyX0Nta-d%^Q%67|Cw zf14gH9yIbvPp5X=vdv@vl0FTM{qP0$&!+wz*$2QY>wZt*W@C;~4>X>Sq;nHx{H+~z zG%jbmr zGe+@)z3wq>;w1N*=CK>z(a zk`I7CYJW8FoH3UuGoPUa#d|1gZvFWi+5pb2=`!&k#wbJL!Ew~TBltjL3)jnV-r-vW z?e*uwupZIhF+ZAPx&g6Iu=dI~s?SF}h(0v$CB{CeY~i`>0i$*aoN%r~$eL2mK>Ncx zhW<|7?+4Cbjlz4#_@|ck;K8|f%#0cjs&*IidF+A%KFPSogd6%G$2LOZ!I{*5Z~8!E zYq{0X>dfbi^n7pmU3mV1vD|#?KJ|By$MZpsCv$FI;#nV`_Z0$ob~p{=yQVRU#xv_z zQ0C+Js{ZbMKL+3akBNWtSdDmByY46SM?b*f8ut{VHdpoOu2_M-H}Xj2=lNB>TjV)+ zmEkihv`KuXJS8|Dyasaw_DVbm4cX^A5O|1sn!st_g2%h^(tt6Pi9OD->K;J$y{kq!#@I~#33BWGEi0{1Oy|B9IaUJFPAbcQXZeDc1gk7^S zzQ=Z5n=ja-vBvNw=>N5@DFyqf{kMSUwaeo92+FkJn!xxbI>*X4_-w%8I>Pfojk$S| z?c>}b&S5mVH<7Qa0{P;aQs=V`s6M;>*BGYuO<0E?+ogbcyca&c5t(0bkT{p|Ap7!0 zT+>IvH|Cyvg7$g~?gO_XPrvp3b@$zl^X~+>?%Q4P%X=`!{UGKFX0Bo>4y{`JH74$MX)?%)FZ#1%B)hj2)3ZC!gt1q-)TUAjKL)qQ|e2?+nA2l9yefKq#@kF4YbTU6+ z0I&nlu0MSDVby^bNcPvYqU06CK*!gN zFJqi@qp!}nd;)DiKJg&zz6tNF(ce>P$m=`vLi<7=SPtmlKi&IM*c!uEfuDAX2OYax z;s;^770~uu9_z$=!E2=ZYmc?lF$Obj(n!1)U4gc(!g)Wo&BzDf8}k|>#Di`b`5b#F zkeB9}Co?~QYYhJd(C3oR$QK7bBj?|oDfk-0%3j($8Q5)PGyInGn?lC3ef3AX-!gT4 z=^+@Gv#KvBu|`<~=mSeoM!p~6drsE=eBwb@oBL5-`hBL1k<;k^kxQZ$DD)b`8^A$9 z*OXGW9))eB=X;Ujy^4|#r(94v2JhJ>ct*L{zc~Wnd$@Y~<2WZCj6PrVQ)f#9k@m>FZ#WKNGjWw}-bwu6YFs-s| z-`Yz~Pf*P=sr$f0eE$^iJ=br)7Z37YWW=|t4gH?}pRlD6Uzi_o4!|{w^y~ts&Kkqj zf%8RM!9hX(=8UqjKek5wRj)iD=PXg!2^KZ^f0kFpKpezn`cPRTfpYt{y zyV8zSU&_0}n^WV>rhreIsH(#_3iB-puN!&L+=wfVNF+1Nbgt z$Qr{9ShprpJjgNvT=Vi#6T6&a!L73fI-Z~V>X2KrPoe)L#(T474-TY~ehvNmWBYZ- zgCkJJK-)}zWPU&~upQ9$0p}U|!oYZN2lz2wV_4Zko2mi*HE(G<`zM&c#5EgC$9Zwj ze_-l_(q0(v38fJIIqTemPNfelLm9b#nx3!a9}jZ;gMS+&)JEL{n3uu~Z1va30M{#j z!FS{X=g`~%Zh8W`=6JRo16y7IwEfXJ7B)G56BGAZZB3|MMaesu?=&1fqirY41RM?g z-sDT*pLHNeurZFIH1ot_zqd)h-*rX075Kqf2JKxnAe5v3cxtt zke*5#BFZv?5Vg2wkEAl?( z2aEwe0`zJM_>T-!*61kX@+5yKp^S?1p|XSC1_{ z0Wjtceq$kC=#A?=4A2L(u8THc7uMj}g?_YN*|Is9w&ib z#@yj(jqg}+^)TM+-v-_VI0i&8K4SfU3m6OJx^!Ycu16a<))6y8YdnVM)G_q0W6(c_ zYw4mK`kz!Yp|nWnzMn8O?WC4*? zS^?dxlLdq+X$3?&t$-+sn^pxx(bEdZwDVB~Y*R_Ez=^af;5P5~%(N { + if (tag === "em") + return { + tag: "Badge", + attrs: {type: "tip"}, + content: "Recommended", + }; + }, + }, + ], + sub: true, + sup: true, + tabs: true, + vPre: true, + + // 在启用之前安装 chart.js + // chart: true, + + // insert component easily + + // 在启用之前安装 echarts + // echarts: true, + + // 在启用之前安装 flowchart.ts + // flowchart: true, + + // gfm requires mathjax-full to provide tex support + // gfm: true, + + // 在启用之前安装 katex + // katex: true, + + // 在启用之前安装 mathjax-full + // mathjax: true, + + // 在启用之前安装 mermaid + // mermaid: true, + + // playground: { + // presets: ["ts", "vue"], + // }, + + // 在启用之前安装 reveal.js + // revealJs: { + // plugins: ["highlight", "math", "search", "notes", "zoom"], + // }, + + // 在启用之前安装 @vue/repl + // vuePlayground: true, + + // install sandpack-vue3 before enabling it + // sandpack: true, + }, + + // 如果你需要 PWA。安装 @vuepress/plugin-pwa 并取消下方注释 + // pwa: { + // favicon: "/favicon.ico", + // cacheHTML: true, + // cachePic: true, + // appendBase: true, + // apple: { + // icon: "/assets/icon/apple-icon-152.png", + // statusBarColor: "black", + // }, + // msTile: { + // image: "/assets/icon/ms-icon-144.png", + // color: "#ffffff", + // }, + // manifest: { + // icons: [ + // { + // src: "/assets/icon/chrome-mask-512.png", + // sizes: "512x512", + // purpose: "maskable", + // type: "image/png", + // }, + // { + // src: "/assets/icon/chrome-mask-192.png", + // sizes: "192x192", + // purpose: "maskable", + // type: "image/png", + // }, + // { + // src: "/assets/icon/chrome-512.png", + // sizes: "512x512", + // type: "image/png", + // }, + // { + // src: "/assets/icon/chrome-192.png", + // sizes: "192x192", + // type: "image/png", + // }, + // ], + // shortcuts: [ + // { + // name: "Demo", + // short_name: "Demo", + // url: "/demo/", + // icons: [ + // { + // src: "/assets/icon/guide-maskable.png", + // sizes: "192x192", + // purpose: "maskable", + // type: "image/png", + // }, + // ], + // }, + // ], + // }, + // }, + }, +}); diff --git a/docs/.vuepress/theme.ts b/docs/.vuepress/theme.ts deleted file mode 100644 index 2b9fdc1c..00000000 --- a/docs/.vuepress/theme.ts +++ /dev/null @@ -1,187 +0,0 @@ -import { hopeTheme } from "vuepress-theme-hope"; -import navbar from "./navbar.js"; -import sidebar from "./sidebar.js"; - -export default hopeTheme({ - hostname: "https://vuepress-theme-hope-docs-demo.netlify.app", - - author: { - name: "Mr.Hope", - url: "https://mister-hope.com", - }, - - iconAssets: "fontawesome-with-brands", - - logo: "https://theme-hope-assets.vuejs.press/logo.svg", - - repo: "vuepress-theme-hope/vuepress-theme-hope", - - docsDir: "src", - - // 导航栏 - navbar, - - // 侧边栏 - sidebar, - - // 页脚 - footer: "默认页脚", - displayFooter: true, - - // 加密配置 - encrypt: { - config: { - "/demo/encrypt.html": ["1234"], - }, - }, - - // 多语言配置 - metaLocales: { - editLink: "在 GitHub 上编辑此页", - }, - - // 如果想要实时查看任何改变，启用它。注: 这对更新性能有很大负面影响 - // hotReload: true, - - // 在这里配置主题提供的插件 - plugins: { - // 你应该自行生成自己的评论服务 - comment: { - provider: "Giscus", - repo: "vuepress-theme-hope/giscus-discussions", - repoId: "R_kgDOG_Pt2A", - category: "Announcements", - categoryId: "DIC_kwDOG_Pt2M4COD69", - }, - - components: { - components: ["Badge", "VPCard"], - }, - - // 此处开启了很多功能用于演示，你应仅保留用到的功能。 - mdEnhance: { - align: true, - attrs: true, - codetabs: true, - component: true, - demo: true, - figure: true, - imgLazyload: true, - imgSize: true, - include: true, - mark: true, - stylize: [ - { - matcher: "Recommended", - replacer: ({ tag }) => { - if (tag === "em") - return { - tag: "Badge", - attrs: { type: "tip" }, - content: "Recommended", - }; - }, - }, - ], - sub: true, - sup: true, - tabs: true, - vPre: true, - - // 在启用之前安装 chart.js - // chart: true, - - // insert component easily - - // 在启用之前安装 echarts - // echarts: true, - - // 在启用之前安装 flowchart.ts - // flowchart: true, - - // gfm requires mathjax-full to provide tex support - // gfm: true, - - // 在启用之前安装 katex - // katex: true, - - // 在启用之前安装 mathjax-full - // mathjax: true, - - // 在启用之前安装 mermaid - // mermaid: true, - - // playground: { - // presets: ["ts", "vue"], - // }, - - // 在启用之前安装 reveal.js - // revealJs: { - // plugins: ["highlight", "math", "search", "notes", "zoom"], - // }, - - // 在启用之前安装 @vue/repl - // vuePlayground: true, - - // install sandpack-vue3 before enabling it - // sandpack: true, - }, - - // 如果你需要 PWA。安装 @vuepress/plugin-pwa 并取消下方注释 - // pwa: { - // favicon: "/favicon.ico", - // cacheHTML: true, - // cachePic: true, - // appendBase: true, - // apple: { - // icon: "/assets/icon/apple-icon-152.png", - // statusBarColor: "black", - // }, - // msTile: { - // image: "/assets/icon/ms-icon-144.png", - // color: "#ffffff", - // }, - // manifest: { - // icons: [ - // { - // src: "/assets/icon/chrome-mask-512.png", - // sizes: "512x512", - // purpose: "maskable", - // type: "image/png", - // }, - // { - // src: "/assets/icon/chrome-mask-192.png", - // sizes: "192x192", - // purpose: "maskable", - // type: "image/png", - // }, - // { - // src: "/assets/icon/chrome-512.png", - // sizes: "512x512", - // type: "image/png", - // }, - // { - // src: "/assets/icon/chrome-192.png", - // sizes: "192x192", - // type: "image/png", - // }, - // ], - // shortcuts: [ - // { - // name: "Demo", - // short_name: "Demo", - // url: "/demo/", - // icons: [ - // { - // src: "/assets/icon/guide-maskable.png", - // sizes: "192x192", - // purpose: "maskable", - // type: "image/png", - // }, - // ], - // }, - // ], - // }, - // }, - }, -}); diff --git a/docs/README.md b/docs/README.md index 074ffc16..f68d08fd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,7 +12,7 @@ tagline: 基于Nonebot2的OneBot标准聊天机器人，不仅仅局限于OneBot actions: - text: 使用指南 icon: lightbulb - link: ./demo/ + link: ./usage/ type: primary - text: 文档 @@ -25,7 +25,7 @@ actions: #5. 启动`python main.py` highlights: - - header: 易于安装 + - header: 快速部署 image: /assets/image/box.svg bgImage: https://theme-hope-assets.vuejs.press/bg/3-light.svg bgImageDark: https://theme-hope-assets.vuejs.press/bg/3-dark.svg diff --git a/docs/demo/README.md b/docs/demo/README.md index 31ede9bc..8d83ff52 100644 --- a/docs/demo/README.md +++ b/docs/demo/README.md @@ -6,4 +6,4 @@ category: - 使用指南 --- - +a diff --git a/docs/demo/layout.md b/docs/demo/layout.md index b89b60a6..123dc679 100644 --- a/docs/demo/layout.md +++ b/docs/demo/layout.md @@ -1,9 +1,8 @@ --- title: 布局 icon: object-group -order: 2 -category: - - 指南 +order: 3 +category: 使用指南 tag: - 布局 --- diff --git a/docs/demo/page.md b/docs/demo/page.md index 23d1b816..3758c7ef 100644 --- a/docs/demo/page.md +++ b/docs/demo/page.md @@ -6,7 +6,7 @@ cover: /assets/images/cover1.jpg # 这是页面的图标 icon: file # 这是侧边栏的顺序 -order: 3 +order: 4 # 设置作者 author: Ms.Hope # 设置写作时间 diff --git a/docs/deployment/README.md b/docs/deployment/README.md new file mode 100644 index 00000000..e4370a20 --- /dev/null +++ b/docs/deployment/README.md @@ -0,0 +1,6 @@ +--- +title: 快速部署 +index: false +icon: laptop-code +category: 安装和配置 +--- diff --git a/docs/deployment/config.md b/docs/deployment/config.md new file mode 100644 index 00000000..9a4f991e --- /dev/null +++ b/docs/deployment/config.md @@ -0,0 +1,9 @@ +--- +title: 配置 +icon: object-group +order: 2 +category: 使用指南 +tag: + - 配置 + - 部署 +--- diff --git a/docs/deployment/install.md b/docs/deployment/install.md new file mode 100644 index 00000000..ea1b9f8c --- /dev/null +++ b/docs/deployment/install.md @@ -0,0 +1,14 @@ +--- +title: 安装 +icon: object-group +order: 1 +category: 使用指南 +tag: + - 安装 +--- + +1. 安装 `Git` 和 `Python3.10+` 环境 +2. 克隆项目 `git clone https://github.com/snowykami/LiteyukiBot` (无法连接可以用`https://gitee.com/snowykami/LiteyukiBot`) +3. 切换目录`cd LiteyukiBot` +4. 安装依赖`pip install -r requirements.txt`(如果多个Python环境请指定后安装`pythonx -m pip install -r requirements.txt`) +5. 启动`python main.py` diff --git a/docs/guide/README.md b/docs/guide/README.md deleted file mode 100644 index ceb99ed2..00000000 --- a/docs/guide/README.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: 指南 -icon: lightbulb ---- - -## 功能亮点 - -### Bar - -- [baz](bar/baz.md) -- ... - -### Foo - -- [ray](foo/ray.md) -- ... diff --git a/docs/guide/bar/README.md b/docs/guide/bar/README.md deleted file mode 100644 index dbfeccd7..00000000 --- a/docs/guide/bar/README.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Bar 功能 -icon: lightbulb ---- - -## 介绍 - -我们支持 bar 功能，... - -## 详情 - -- [baz](baz.md) -- ... diff --git a/docs/guide/bar/baz.md b/docs/guide/bar/baz.md deleted file mode 100644 index 279514cd..00000000 --- a/docs/guide/bar/baz.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Baz -icon: circle-info ---- - -功能详情... diff --git a/docs/guide/foo/README.md b/docs/guide/foo/README.md deleted file mode 100644 index d99a74f7..00000000 --- a/docs/guide/foo/README.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Foo 功能 -icon: lightbulb ---- - -## 介绍 - -我们支持 foo 功能，... - -## 详情 - -- [ray](ray.md) -- ... diff --git a/docs/guide/foo/ray.md b/docs/guide/foo/ray.md deleted file mode 100644 index d4cbb584..00000000 --- a/docs/guide/foo/ray.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Ray -icon: circle-info ---- - -功能详情... diff --git a/docs/usage/README.md b/docs/usage/README.md new file mode 100644 index 00000000..cec4fce3 --- /dev/null +++ b/docs/usage/README.md @@ -0,0 +1,6 @@ +--- +title: 使用指南 +index: false +icon: laptop-code +category: 使用指南 +---