From 546facf77ea1e652e0c4b9b10ffa071be1b1a913 Mon Sep 17 00:00:00 2001 From: userA Date: Fri, 19 May 2023 02:03:45 +0800 Subject: [PATCH] README.md --- FileModule/README.md | 1 - README.md | 4 +++- doc/ReadMe.md | 21 +++++++++++++++++++++ doc/docs/.vuepress/public/img/favicon.ico | Bin 3471 -> 41662 bytes doc/docs/01.指南/01.快速入门/01.简介.md | 2 +- 5 files changed, 25 insertions(+), 3 deletions(-) delete mode 100644 FileModule/README.md create mode 100644 doc/ReadMe.md diff --git a/FileModule/README.md b/FileModule/README.md deleted file mode 100644 index b0e0b2f..0000000 --- a/FileModule/README.md +++ /dev/null @@ -1 +0,0 @@ -# FileModule diff --git a/README.md b/README.md index 685b9cb..d1723a0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # ChopperBot项目框架 -👉[项目文档]👈() +👉[项目文档](https://twj666.github.io/ChopperBot-Doc/)👈 +👉[项目文档更新指南](https://github.com/969025903/ChopperBot/tree/master/doc/ReadMe.md)👈 + 👉[更新日志](https://gitee.com/sbg-genius/ChopperBot/blob/master/CHANGELOG.md)👈 diff --git a/doc/ReadMe.md b/doc/ReadMe.md new file mode 100644 index 0000000..87ec6bb --- /dev/null +++ b/doc/ReadMe.md @@ -0,0 +1,21 @@ +关于技术文档的更新 +1. 请用idea打开ChopperBot中的doc文件夹 +2. ![image](https://mynoteimages.oss-cn-hangzhou.aliyuncs.com/20230519015418105.png) +3. 修改docs中对应模块内容 +4. 上线项目 +- 如果github中已经有页面分支了请删除页面分支 `pages` +- 在当前的项目 doc/文件夹下进行 `yarn build` +```cmd + +# 导航到构建输出目录 +cd docs/.vuepress/dist + +git init +git add -A +git commit -m 'deploy' + +# 推到你仓库的的 gh-page 分支 +# 将 / 替换为你的信息 +git push -f git@github.com:twj666/ChopperBot-Doc.git master:pages + +``` diff --git a/doc/docs/.vuepress/public/img/favicon.ico b/doc/docs/.vuepress/public/img/favicon.ico index 796d2d90448bdb644315ffebf46ef2f358053d8f..6384123c2348f4c4dc303e19b3528f10feb4b9ad 100644 GIT binary patch literal 41662 zcmeHQ2~<@_n#Sof)6>&uPM zsBw)^lNdE|-`b@+Tc?v~I%Yb%wi-3YsPUiwt4CcfkNf037I|FW<6P=i-Kx6vf8VY8 zYx!?o7ner-H(-DZ|2Mj9-|XV@zb-B=K74SH%XvN!j$dMti_33+Z9YVR^Pdv|Cjw3c zoCr7(a3bJDz=?pa5eWA3`X7^rTaw9W>}xW*O*0t{MJ9K*L+oDib2t3e1T9%z~{ur&+v=G==L3lf9&V(c8=ZGIb8|6`JCTiKcg|#1S-*hcR2vxPMfNFEFmX!)Ul`=F700@7Xob!vn*E2L1E%YV66FuVo(YsId=j>P797 z;%HdU&NO9sKUz3x6cx>zOuJXjqk|ilisQtNHFRR<8v4_|jdba?&Ehz@Ypn=7`tnM8 zt#~o*SU#6F6ilO~Q^(TO5&daI@6ME&nnZCS0a`piLH*h^7j?Ia6Nv^ZR%VvFRx$fkr!Dvw6Kt2Z?K+Noi~A|al1b#s{>`W zNv718NQw&%ph!O-f{u~-1bVrPFoeej`%_XxD5b|Yqb{k5)UQ)IjqcZtX1q9%UYe0D zbkONn*4gwNKp*7{>`8%M=C+LM%9$_^kKgEx6N#h59`3ol#RC67cFCZaAU_3bZrfDn zHP_!tjtr%tJvz~{>Ej5vtIJ|}zWt>PatjOru>Z^R4o7Wb1ND z2oDzNxcyqHS3dH_4NtRd$?ROti;pO)!yJ&;B zcYv3taM8~jnAM)FwP)!2A%7mDKGYQ-rDJNeQO9?z7X4gnI9dz0#!pq^Z}{Rm4dVI} zY%=Tb)YvFdF3WZce&mlsUwjx&LZ%*VThY!H`E+XcIw7ML##O;rD<5lN@rema-COn7 ztCZL>MUnI*R*V@y$j2jP5-sbJ%d|J7F>nnO8t#R;{I3`wuF(%ll}#Yp?tth5DQO z6I%;sRp3OHRZsN;vUnQ|M&@LNpV4rI_2YfW3H;mj>P^t)DQRicD|@`acmA={wDSE= zgx=oz&mRU89f!}593o8KCaYJDrQdzx!4A8To}@?UiNg1{X8Und{7k2SO~wwDiU@ez)r zq4Tlh?ju@y;V(39-FoVsGl9@oLLW3DBt-P3Bu=t#6%`RK+JE$|QqtQB4BPeUMcqb> zqJC3n(C~#zD0kBqn)mie*7u*$_B#*D=_4&ZFcw94Km)HI(5;c-VHBU#g1U_wP2<)S z2^`V?!FR1qFi%$U z-S@Qilg|Yo$N@R+x-G_wX_5GH3{e1qM*Ze*Fa>om<8` z`LLKflz3@jsTEe;_#3~xL9MvYi+m;w?&IX6j`@JT$Jh{jY+c%L=1VYs^7;Mme=F>v z+zsO(f5#X43tbDni#aJA{v3{Lm=l*_zzh8;%xSf1*N!^$=_~Yq|7kNtT+F-7Ie3JY zzx!diK7cLt34IFO4`cI-`^#)sWWN{JaOh?HCv4q}Zn-SeWj=nE^3|q`zHw6P*3@e%+xbeioxfCKETU~h%v&CSci^#g2Ug|*b; z`ID(|+8AC(8A20=^bvMjS#6RCYqGe9yq~sPemyw2i6q%3uXWlh{y%HZgHm|R`|i*3fT**@n4A7691pUAS;l?&Yw>F+~{ z5h0WoA5Hx`rwcn?*mYHA<716GDT^cX0sBv06=5zHWo(-e%eJfQt=1DMhojXG*4;TM+kkHE6)ukKT1^qW<{TFpPAwAR zsbz99wMgU<|<{i z z=}oZ_VHLPY;W`o;;4jwsv~a2{Y|D*%q}%!PL>Bj=b16 zt6uTJT!^`kTc4g5^2Ol2i^PNqd^B$sO)WDrs*L48UNa00^sjPyH7EIRpCITHEgodp z#lzbKA6jdJXtNx(e#ml3IiS1M`a-r<%~+S@ZrWO9JYfggbIiCZr&sdTQON@!u~R=&>UK(=hp{e(9hw?r z%X9QEWquXfE9P^?-q)U*-ZDSM@@)DjcUIB~dKvBXE?SnMI4vUbLysfeW;! zCtoeDlnclr>wvmm$a8tElE?L#U*@^?H&M1#^Cu}X9^Pr5-$gwUb0@0#U9?-^Bqlb7 z3QnEZ#1VGPu#rN$5*rz*@F4qY(nVgeJZ=vQ2w;1-j0$sO=tn_!_n$Idyo(sZdkxsi z#TV}#5qw~sS8||s9hDDWqiu__h5LHbxq~GNCz$6&+Xa219wSRRo|TJxH)GvBW9(p? z+9;_@j=fSO_{d0%saJfULNX^Cfp3^^Q`)p_Hr={vo?Dc%)kk+M?;iu1CJ%d|-tmF` zhj`w-SU&UE*Pvv@9J*nH&U8esj7KDeE&=5O&*6WbfKVcV&eu@Mv- z6hP5|CS@)J?<2#X7!fS4w`m?N;%B8N(-7>v_~HOsGIN}$vv0h-oIX6WSM&KebzlSQ zJM*3l*eBy@`vpqb>ICE}-Za3&HGu0&KJ#-;mfw;a)SbB#Mo{;RRuszmM;)&=&%t4j zj8t)Nv`@=s=kVTUo?0Rl9}|%ngzn1UD~#*Z9iZyCBuc?`=&w>e;fBLuvcZlgi+!hC+yLP{W6>L zzM|@RMp+JoVSQG;SEs#sPx9mXc$ zgWs|EL3y}zaKe0uZ%W|(*y>{REYo97tF(T6sRJ4m5txtTkZaRo+xz{`5_fC&!uV9w z52N9g~vIYD&d@%8va6RsnVu@-lzM0+jHQFy_8XN1XH@ZoDTM(Kot3Sw{_*@|Zl z`I4(v&0)*FUL{vM6Pbp*er zD1PpZGnkJj_$H7&>kw+pYU>Il( zeLP(Kd7s4(zzGhtd-^ zjKtV`!+Ul53HB=Z2B&46!gp>*_328SuCz`V9<2sBF@m>Qk zP7DtccD4J87O_pxpvRGZ-VeK_r~I%YpZ6DId#K_86`rYQ@tGrZG{%bBS zzeK*J`8@$j)64u1;QvjTAJJSImHDs1kAjt^H~SMT{00j@XIL(N&G|+7P~g)1&EH&e zT))6qRo>%(Q{|sgJ-*msw#W$nr^vmbR5+6&yCBE{De=FR>bs@iEO1%-VCgqMk<*p>Yev-4Ps()xn5sRZuN_?h_(SM5nw#cq5{sWhUa`B&-n{9c2s%bxN#y=&0vsd{4 EA4A$EssI20 literal 3471 zcmV;A4RG>_P)A;5Dqy+P=TPLA|eFkbPWMCil~Tk$+0L3F9u?aF);y^BMOX3UX18d6R+5LHQ8^w zx_9UMdS-iPzS-S+uYSPxbk|qaUww7A5P5*2qN1}9u?Z1R0Khwl_$mNAj))U0Dk?sa z51P6SAmUs^d>0X&G@t1@Uy+v0C z0I(79L&@Zdfib6P{vc=H+G=O(ib`kJ_%bJI+gu2Lw=C-`VbgK;*=K(S0H!12(*W>+ z6gVP2hKR$25WPfK1OV8}ng8d9>Ye1?1`lptR_R1-&rVnvCJoVO^c(;*EAo?PU8Kd)%R{A3F*oH>vS;9v20{F7nOV_DV@0pPWOD)85& zoozdr)_yuvbC?r6{p#bov?(OOqL+4a;`^-9{}7Z z?>Ay-v2!}j3-IiwTF>r7#Qwr`=-apN7rAbYmqeXqbIYCI-dpQDeP69}?~)3qZb(0m z0G3=mP$__ycPE_k0Z}f5IoZA(-zxs%G$ zF6`hvHIB_p%;h5{{) zSBk(yRll?*p2TaW3}{_YLzSK>ed*kKjDxdS0hwDADD2*T)3Z1D>M(lnMc^5pJ> z@;Q^4_f6Is`6}d($iF|owcc}0%B+n>&k-g7090{Xn;fv9hikkfs*DX0F22$Y&{3SJ zv9a+Z0chGPe=~Djnf7cdDR$M*{AmN)z3#6&6Ha}l$Ej=*h5!Y-j!DAEiBc{2#q9~F zxSzY=I~S_GQxYimAuP)ptRlv??N4#*Oci}4+_Iw5W1Z3ApYGZ_uJ>4GM}#SWh*wC$ z$kI9fhnQE1y6@xbsy#2lGY_a=gxlu0&KiYb zgh@bICvKANYEqki%jUX^8CVu|Uf!)%Lsw65)fVM++oORhDmX)bf4`ccx3B~L{5riV zyyOBmSciy9g=v6@`z3*wjZ*8==Qh`Qa=@E3u_T}Vr8lsz|M>uLLn}jT^$cySbxq>M zSE<9~FYWRg54LUB2-5%n8o5cTdjlsi+xn*?^gcvGwaYL>ytSR@|55&(-fq>sh&C?J z{p;1SBHGbR_#YS<8=_=3&j~M>q1Nr2m$}(5GBtGqTmCao!0c6?HjG3f-{B0Uk{8vz znyzzAN;-&jVHEC<7^nX^AmTjkg&uz-y%~6NPlLw_SvtEsBei8&Rzg14w(TkM{|60- zrYs!Qy(q*Wub+2W`_31~k>`1WbvFr9p}4sCYb}w(6tU}XQk$d;St&}8Y}tg1JjwHI z^0@%eEdPJbBsD|HHy|HDUQfkgs_T#KNO-PC#ByOW0KnanSUTub+xvGLy`Jul)oNxu zu+)>Ze?Jn5e1nRqc+KfU%hU(@#wG4ON{j7OI6`$j35YTOU1Or5no`78qW5T`k)xTX zOCjhCllHTyen|eCatJz4e8#12n0x9N_45dCoZ-n)KOqVM5b-HV^fb*P@43bGbo<3@ z=g3xd_~5#!ZukHZpXWP{EGyM-DKbiDlf3>{H>*{oKY|MY*NQ>_%d$qfCMi14ZmLVW zz~hh9J7uM=jwK5vle_{~KkF6@4s1@6sZ7Zj)%6sL_7x6iRUnXaAQKS){vip!d8XPV zop)Jg*|K4E9-pAql>O6#=><(l;pR*#C8*edJ>%_yshA@mbFI}RjjIp4{p-DNwbqWG z@7nPasjy1N(Ao+&2BoW%AiUPA?mAp5nG5Iz0A&DhGXOlv8ANaP@I-N1w3#(TCaLOL zx|d%7OJ}RSUy8bBQYk^`d(KtDWN68bz2Ij|u5hL1jpm+o?U0z3`BbgV?_X3@WC=r| zHzKac7vqs3IdAFEFzrp9F zrt;2h-)0J9*nxc$Lh`8DeYXe`0TD;@#Z!Hd?f?xNpW0aK(beSL`prwqJ#&MA;!wK# z*05SpM4To}gGeOuX+-=RkHJ&YJ(tW+wjlW#{h2S}Kak1em4BNxUhn<-!_`#kC`<#} zwl9?gQgZ{niTPlDvYo)*MMJ$NDX;6%#ftpJTIA0d*+EHq(S57b^*6b|9jo1-8C7Ta zcgVac15)RPF81%Q+@LNSVIly)OOnWqOVsr@xxhz%S?xIovb_%pi03H~al9}Qc-&uC z=a~y!x4=~!K`Nqy_6i{4_k@YSiKGBoKAC^2*&81Ua?l1TpG3ry!c;It0H>Q9oa?81 zY<6c?lRB{zw2U4RHwaT9-vT(cBjN14y((1!$7!Lm@{Zh>M`jW64q+-F;&GWo(X|}O zH<3_k)oYJXz3CHC@L!Y(U@T+&AKW$iPS&bS&T=-ROLc@gFw2h00>^$+b}-p z!l?X^SEFGFNV|#RP8)8i(3YZfdjZJwBSj*kJ~c#jI{WXePMsw|k#>|W0pHaH(EH)# zL+0rUYum$pYpeavj<%UDS6DCt0Dz4|WMgeVPft})e0Ec zHY$zE?1ia-h}$!%HqHbOZ>jHaYB5{nJ;c-mC`<)vSd)ZONk~4JmFxuc73Gc=rh;Wz z(R|zN$&iuC*o`mB^)+U+PN$`Qs(dpr*+KL*<-K8SQ$~9OQmIK=H}uGKoHoWY3SpNp z9U_s)7ie;cB$|q(@)5sDhJbYF^KKj4wnvCU0GhSW^(F<>^3BX-7Px4ZXGG>1n!qRu z1n4X{;J!Kfag<5JkopJsL@XmmlBvM9?Qa1If14z=c2^l&Xm-$vh$T3v)UFpiXoJps9k0_$Xf-x%gpJFDFC9D_Juh%{UTW z2_lim$7t3*7Xl4Gq8Xe?1DH>0kxx!Hwi&OZfQXB^5KIYKY-eRK)Nt4(KIEwwalcJ2 zmS#5WGoY)Ik1nREzoIJxyKxPt5c7%bP z4n&NI?gG^Qk1Y$QPaO6LAjd%8ZO4EU(|dM6CjcUDGNCiF+o~V{SS}Y%MNs)*K8++U zxX;&y1&BCKE}Se8>JQ7bNxLIRgPnYzCVb1NucYQEk^fJh3dkGMjuhPu5V4$p{4I~n xKV