From 7cecfd1053efc7973bfbe9c6b6d678b50ecbf092 Mon Sep 17 00:00:00 2001 From: snowy Date: Thu, 28 Mar 2024 11:12:55 +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 --- docs/.vuepress/config.ts | 24 ++- docs/.vuepress/navbar.ts | 27 +-- docs/.vuepress/public/favicon.ico | Bin 67646 -> 67646 bytes docs/.vuepress/sidebar.ts | 18 +- docs/.vuepress/theme.js | 187 ++++++++++++++++++++ docs/README.md | 278 +++--------------------------- 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/usage/README.md | 6 + 13 files changed, 270 insertions(+), 308 deletions(-) create mode 100644 docs/.vuepress/theme.js create mode 100644 docs/deployment/README.md create mode 100644 docs/deployment/config.md create mode 100644 docs/deployment/install.md create mode 100644 docs/usage/README.md diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts index 8a401869..2b8b1d13 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"; +import viteBundler from "@vuepress/bundler-vite"; export default defineUserConfig({ - base: "/", + base: "/", - lang: "zh-CN", - title: "文档演示", - 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, - - // 和 PWA 一起启用 - // shouldPrefetch: false, + theme, + // 和 PWA 一起启用 + // shouldPrefetch: false, }); diff --git a/docs/.vuepress/navbar.ts b/docs/.vuepress/navbar.ts index 20467d38..0a0a9d28 100644 --- a/docs/.vuepress/navbar.ts +++ b/docs/.vuepress/navbar.ts @@ -2,29 +2,6 @@ import { navbar } from "vuepress-theme-hope"; export default navbar([ "/", - "/demo/", - { - text: "指南", - icon: "lightbulb", - prefix: "/guide/", - children: [ - { - text: "Bar", - icon: "lightbulb", - prefix: "bar/", - children: ["baz", { text: "...", icon: "ellipsis", link: "" }], - }, - { - text: "Foo", - icon: "lightbulb", - prefix: "foo/", - children: ["ray", { text: "...", icon: "ellipsis", link: "" }], - }, - ], - }, - { - text: "V2 文档", - icon: "book", - link: "https://theme-hope.vuejs.press/zh/", - }, + "/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/README.md b/docs/README.md index 16ef4fa2..f68d08fd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,280 +1,42 @@ --- home: true icon: home -title: 项目主页 -heroImage: https://theme-hope-assets.vuejs.press/logo.svg +title: 首页 +heroImage: https://cdn.liteyuki.icu/static/img/logo.png bgImage: https://theme-hope-assets.vuejs.press/bg/6-light.svg bgImageDark: https://theme-hope-assets.vuejs.press/bg/6-dark.svg bgImageStyle: background-attachment: fixed -heroText: 项目名称 -tagline: 你可以在这里放置或是整个项目的描述。 +heroText: LiteyukiBot 6 +tagline: 基于Nonebot2的OneBot标准聊天机器人，不仅仅局限于OneBot actions: - text: 使用指南 icon: lightbulb - link: ./demo/ + link: ./usage/ type: primary - text: 文档 link: ./guide/ +#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` + 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 highlights: - - title: 运行 pnpm create vuepress-theme-hope hope-project 以创建一个新的主题项目。 - - title: 在已有项目根目录下运行 pnpm create vuepress-theme-hope add . 以在项目中添加主题。 - - - header: 在 Markdown 中添加你想要的内容 - description: 我们扩展了标准的 CommonMark 规范，为你添加了成吨功能。 - image: /assets/image/markdown.svg - bgImage: https://theme-hope-assets.vuejs.press/bg/2-light.svg - bgImageDark: https://theme-hope-assets.vuejs.press/bg/2-dark.svg - bgImageStyle: - background-repeat: repeat - background-size: initial - features: - - title: 链接检查 - icon: clipboard-check - details: 检查 Markdown 链接 - link: https://theme-hope.vuejs.press/zh/guide/markdown/others.html#link-check - - - title: 提示容器支持 - icon: box-archive - details: 用样式装饰 Markdown 内容 - link: https://theme-hope.vuejs.press/zh/guide/markdown/hint.html - - - title: GFM 警告 - icon: bell - details: GFM 风格的警告容器 - link: https://theme-hope.vuejs.press/zh/guide/markdown/alert.html - - - title: 选项卡 - icon: table-columns - details: 使用选项卡对相似内容进行分组 - link: https://theme-hope.vuejs.press/zh/guide/markdown/tabs.html - - - title: 代码组 - icon: code - details: 使用选项卡对相似代码进行分组 - link: https://theme-hope.vuejs.press/zh/guide/markdown/code-tabs.html - - - title: 自定义对齐支持 - icon: align-center - details: 让你在 Markdown 中对段落进行对齐 - link: https://theme-hope.vuejs.press/zh/guide/markdown/align.html - - - title: 自定义属性支持 - icon: code - details: 让你为 Markdown 元素添加属性 - link: https://theme-hope.vuejs.press/zh/guide/markdown/attrs.html - - - title: 上下角标支持 - icon: superscript - details: 你的 Markdown 现在将支持上下角标 - link: https://theme-hope.vuejs.press/zh/guide/markdown/sup-sub.html - - - title: 脚注 - icon: quote-left - details: 你的 Markdown 现在将支持脚注 - link: https://theme-hope.vuejs.press/zh/guide/markdown/footnote.html - - - title: 标记支持 - icon: highlighter - details: 让你在 Markdown 中对词句进行标记 - link: https://theme-hope.vuejs.press/zh/guide/markdown/mark.html - - - title: 任务列表 - icon: square-check - details: 在 Markdown 中使用任务列表 - link: https://theme-hope.vuejs.press/zh/guide/markdown/tasklist.html - - - title: 图片语法 - icon: image - details: 使用改进的语法指定图片大小与颜色模式 - link: https://theme-hope.vuejs.press/zh/guide/markdown/image.html - - - title: 组件支持 - icon: puzzle-piece - details: 在 Markdown 中轻松插入组件 - link: https://theme-hope.vuejs.press/zh/guide/markdown/component.html - - - title: 图表支持 - icon: chart-simple - details: 在 Markdown 中展示图表 - link: https://theme-hope.vuejs.press/zh/guide/markdown/chartjs.html - - - title: 流程图支持 - icon: route - details: 可以在 Markdown 中直接写出流程图 - link: https://theme-hope.vuejs.press/zh/guide/markdown/flowchart.html - - - title: Mermaid 支持 - icon: chart-pie - details: 可以在 Markdown 中添加 Mermaid 图例 - link: https://theme-hope.vuejs.press/zh/guide/markdown/mermaid.html - - - title: Tex 支持 - icon: square-root-variable - details: Markdown 现在也可以支持 Tex 语法以显示公式 - link: https://theme-hope.vuejs.press/zh/guide/markdown/tex.html - - - title: 导入文件支持 - icon: fab fa-markdown - details: 将你的文档分段，并在 Markdown 中导入 - link: https://theme-hope.vuejs.press/zh/guide/markdown/include.html - - - title: 交互演示支持 - icon: code - details: 你可以在 Markdown 中添加交互演示 - link: https://theme-hope.vuejs.press/zh/guide/markdown/playground.html - - - title: Vue 交互演示支持 - icon: fab fa-vuejs - details: 在交互演示中展示 Vue 组件 - link: https://theme-hope.vuejs.press/zh/guide/markdown/vue-playground.html - - - title: Sandpack 交互演示支持 - icon: code - details: Sandpack 驱动的实时的编码环境 - link: https://theme-hope.vuejs.press/zh/guide/markdown/sandpack.html - - - title: 代码案例支持 - icon: laptop-code - details: 你可以很方便的插入代码案例 - link: https://theme-hope.vuejs.press/zh/guide/markdown/demo.html - - - title: 幻灯片支持 - icon: person-chalkboard - details: 通过 Reveal.js 在 Markdown 中插入幻灯片 - link: https://theme-hope.vuejs.press/zh/guide/markdown/revealjs.html - - - header: 布局 - description: 一个带有完整无障碍支持的响应式布局。 - image: /assets/image/layout.svg - bgImage: https://theme-hope-assets.vuejs.press/bg/5-light.svg - bgImageDark: https://theme-hope-assets.vuejs.press/bg/5-dark.svg - highlights: - - title: 布局增强 - icon: object-group - details: 添加路径导航、页脚、改进的导航栏、改进的页面导航等。 - link: https://theme-hope.vuejs.press/zh/guide/layout/ - - - title: 深色模式 - icon: circle-half-stroke - details: 可以自由切换浅色模式与深色模式 - link: https://theme-hope.vuejs.press/zh/guide/interface/darkmode.html - - - title: 主题色切换 - icon: palette - details: 支持自定义主题色并允许用户在预设的主题颜色之间切换 - link: https://theme-hope.vuejs.press/zh/guide/interface/theme-color.html - - - title: 幻灯片页面 - icon: person-chalkboard - details: 添加幻灯片页面以显示你喜欢的内容 - link: https://theme-hope.vuejs.press/zh/guide/layout/slides - - - title: 更多 - icon: ellipsis - details: RTL 布局，打印支持，全局按钮等 - link: https://theme-hope.vuejs.press/zh/guide/interface/others.html - - - header: 新功能 - image: /assets/image/features.svg - bgImage: https://theme-hope-assets.vuejs.press/bg/1-light.svg - bgImageDark: https://theme-hope-assets.vuejs.press/bg/1-dark.svg - features: - - title: 浏览量与评论 - icon: comment-dots - details: 配合 Waline 来开启阅读量统计与评论支持 - link: https://theme-hope.vuejs.press/zh/guide/feature/comment.html - - - title: 文章信息 - icon: circle-info - details: 为你的文章添加作者、写作日期、预计阅读时间、字数统计等信息 - link: https://theme-hope.vuejs.press/zh/guide/feature/page-info.html - - - title: 文章加密 - icon: lock - details: 你可以为你的特定页面或特定目录进行加密，以便陌生人不能随意访问它们 - link: https://theme-hope.vuejs.press/zh/guide/feature/encrypt.html - - - title: 搜索支持 - icon: search - details: 支持 docsearch 和基于客户端的搜索 - link: https://theme-hope.vuejs.press/zh/guide/feature/search.html - - - title: 代码复制 - icon: copy - details: 一键复制代码块中的代码 - link: https://theme-hope.vuejs.press/zh/guide/feature/copy-code.html - - - title: 图片预览 - icon: image - details: 像相册一样允许你浏览、缩放并分享你的页面图片 - link: https://theme-hope.vuejs.press/zh/guide/feature/photo-swipe.html - - - header: 博客 - description: 通过主题创建个人博客 - image: /assets/image/blog.svg - bgImage: https://theme-hope-assets.vuejs.press/bg/5-light.svg - bgImageDark: https://theme-hope-assets.vuejs.press/bg/5-dark.svg - highlights: - - title: 博客功能 - icon: blog - details: 通过文章的日期、标签和分类展示文章 - link: https://theme-hope.vuejs.press/zh/guide/blog/intro.html - - - title: 博客主页 - icon: home - details: 全新博客主页 - link: https://theme-hope.vuejs.press/zh/guide/blog/home.html - - - title: 博主信息 - icon: home - details: 自定义名称、头像、座右铭和社交媒体链接 - link: https://theme-hope.vuejs.press/zh/guide/blog/blogger.html - - - title: 时间线 - icon: home - details: 在时间线中浏览和通读博文 - link: https://theme-hope.vuejs.press/zh/guide/blog/timeline.html - - - header: 高级 - description: 增强站点与用户体验的高级功能 - image: /assets/image/advanced.svg - bgImage: https://theme-hope-assets.vuejs.press/bg/4-light.svg - bgImageDark: https://theme-hope-assets.vuejs.press/bg/4-dark.svg - highlights: - - title: SEO 增强 - icon: dumbbell - details: 将最终生成的网页针对搜索引擎进行优化。 - link: https://theme-hope.vuejs.press/zh/guide/advanced/seo.html - - - title: Sitemap - icon: sitemap - details: 自动为你的网站生成 Sitemap - link: https://theme-hope.vuejs.press/zh/guide/advanced/sitemap.html - - - title: Feed 支持 - icon: rss - details: 生成你的 Feed，并通知你的用户订阅它 - link: https://theme-hope.vuejs.press/zh/guide/advanced/feed.html - - - title: PWA 支持 - icon: mobile-screen - details: 让你的网站更像一个 APP - link: https://theme-hope.vuejs.press/zh/guide/advanced/pwa.html - + - title: 安装 Git 和 Python3.10+ + - title: 使用 git clone https://github.com/snowykami/LiteyukiBot 以克隆项目至本地。 + details: 如果无法连接到GitHub，可以使用 git clone https://gitee.com/snowykami/LiteyukiBot。 + - title: 使用 cd LiteyukiBot 切换到项目目录。 + - title: 使用 pip install -r requirements.txt 安装项目依赖。 + details: 如果你有多个 Python 环境，请使用 pythonx -m pip install -r requirements.txt。 + - title: 使用 python main.py 启动项目。 copyright: false footer: 使用 VuePress Theme Hope 主题 | MIT 协议, 版权所有 © 2019-present Mr.Hope ---- - -这是项目主页的案例。你可以在这里放置你的主体内容。 - -想要使用此布局，你需要在页面 front matter 中设置 `home: true`。 - -配置项的相关说明详见 [项目主页配置](https://theme-hope.vuejs.press/zh/guide/layout/home/)。 +--- \ No newline at end of file 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/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: 使用指南 +---