From 5d23c7710076193c19dfcde0173c5ecb4f430499 Mon Sep 17 00:00:00 2001 From: zuiidea Date: Fri, 2 Nov 2018 18:13:43 +0800 Subject: [PATCH] :memo: Add some Chinese documentations. --- docs/_media/favicon.ico | Bin 0 -> 67646 bytes docs/_media/logo.svg | 24 ++++++++ docs/index.html | 8 ++- docs/zh-cn/README.md | 80 +++++++++++++++++++++++++- docs/zh-cn/_sidebar.md | 6 +- docs/zh-cn/configuration.md | 102 ++++++++++++++++++++++++++++++++++ docs/zh-cn/deploy.md | 11 ++++ docs/zh-cn/getting-started.md | 90 +++++------------------------- docs/zh-cn/router.md | 5 ++ 9 files changed, 244 insertions(+), 82 deletions(-) create mode 100644 docs/_media/favicon.ico create mode 100644 docs/_media/logo.svg create mode 100644 docs/zh-cn/router.md diff --git a/docs/_media/favicon.ico b/docs/_media/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..7ca2170ea0f4e0472c56924a402807e10ddf0220 GIT binary patch literal 67646 zcmeHQ349bq_U?e7BIY0g5{@K5xJ3m#7d0y?c(4nKh$pvzkOSpZgoIny8wABwSy53C zMZ6H@X7K>z5Zy~xS=Ya}qH@ekuJ`|5b-zwcPxWL#VBO8c-=n&!Yx;ZrzOPMy zG>fLUKk5OY{Q4FZB-)n8Wr{_4^^Te!7oSmPU3gm1x}bB&>e}&ub-r$=2Ey99b_%Gz z-O&G%GwG=LcsPM*QZl&aI46O3lx%smEgIeE80rcwj6Bhz5wLvNNSqtf@NmLgbTh8W z_=Sv77Y5vd#57nY4q2d!?W{bY6R9IDl| zQz#YuUkLsSVRymipMPrLakS0F@wDG|JTMsicf7E3sP2WG%4>8xeV=vl86|SL|B8~v zfcrwk_2%Rn;J*pD?+v>HTt7j1CoYCP4*sWs{~l;dqr8R*XtU@~T@K6r(HP_z=Ktoz zW59oV@Lvd=g}_(|+W_p6Veb;n5JuspB8NoBVbuK^l(z8QW-;00! zxqud&g)t8bjkO0TYEHTb%})*l*;Id#!F3E=*G#C{#d zUO9}E6`*7b;{f%Mu)GsXpoQf)*O`W4j<~h)A>AU4LmuCL4{Prt@V|*hL34u7rS607 z$4F>$WZm8HV+7?V*Wvl-P=5vvB&$#NfYtN7U`~&70uS}*a^UOBesh3O5|@`r$!%PB z&bjBEy4^P*{VQ<(ufIDdQ26^U!4rF5@axn7=F}QAI_XlnCGjtaKOz1wl(BMcHe{>=_P`yoDv21JXl4pd&+0}YI!yrfz*sl`D%ado$V^$d}9 z#rc7=d*ue!z$$v4cYxS%OufzvsAE;fG1q%(=k30BAMWpdR{G`!_FtYGxWD%W!Nz^N z1+8nKvtP>(jmP?WY*J_NzZ3B%Wvl_k0rTLP@F3%nP>fa#5X}>|GD9JW!5=4Ut4`H3Ut5ng20a6T?15U z2h{PEXk)8vHyzu3xsOlZ5U&5+Ro#MF*IgQl-N7T=lP07e5B{G({7Knplx(^dOdNQ1 zkdL__|HQk&|FH+-GWf3r{Cj|1;fo)p1!zsQC^GVz)VEuJaBMXF93Sg-`HZwl$?bMub?u6)y9X9rdr7F?fXjk0`*@@}(gYrR zDLoPY?`f>VKkLA&fr#;F;K1hMQ}F*A8kG{0%QPPA{c*`%fd9F|S3V^9>(JE!eAMR# z(P9BKSde%V_^%O*12_CWVD-N&n0fuB!Pl<4BtS>SE)DDlUJ>}OGpN^p?)i{zO}D^* zB8^Xe3hOUY#_=DE<7irNIe-RCYlOnY+rj@avBV$z*QW7F_ruC;e8%>{_vR$_gYmud zQ$gaZ&_GO+Q2$=R+WmS2@4TT$pbSP;+4V8>k!wWn8~m>S?}9yU>=`Dr_}1-D|BAJp22_h`+b1KZs-Xepl&qh96n?Bm%dUupW|!E=lkKD zd+o6H;EI8lm)5)ShX2go0Ns{yEZvqo8yX-Lep8$uz!?Z zRs3mU@-eVmfnO1UAEpEL0k~ctWPKuKCH~J?J7T9Y`p}$0A06D1_#NGx5}p6a*w>$wG8EVWh41x&^)~^&hz?Eo zN(UYv>|C%H`$(5X3&-`n_gMq_1ji4!Dp&#|9Ftr23D|XRllF){dVi;%d`|DHAItUh z@~YtOfmesl9oX;atpjNa*8Ih(&A|U=%)z9L4UOt(6yn$0sTsj+B%S?rqrOKl;Oy~0le!Y zWnLX9E)Z9j2ON7j5G|;@Eb}vSk@PZ+P4-=XtK45yuQ%|&KPY^^xk2V6wMI}{*oifZ zul`sU1FsKu8hBms?*p#|hdwrl+pqIKZ~WZB^mqCWx-PhAaKDgmyrSv&V9(Js9{cqg zg8w&RM3ce)WR!k7VE)B8{(c;&T!8aqv6dT`JPOZsHBG+JOyEyVOT_qp%81W?NG^!T zNgjN^xnUgklEx<2HsMR#pc{g{VBfUeJcK}0api3E)Wj9IUzy^=&y5N=Yvnc|Cu!2yriMedw~CXzrh^z4ScY% zb$r%iRaz7sde^M>-0&UtGcKjEW_*e5-~quQgZl?dVe~7oe-9oII{23sax*cOG-rTC zGt%lH|1U-SNf~nx#sli6e4uN=)d9HDIT)W*jy2nSnwWaLpG$OagJY0`=J?_(EwB#; z9Y|gfd@1#uG$Hu~_>k&{FYSW|h6;uZ4AGE*LE8q|$AhKrDZ|^*caZZrPd~n1cwh93 za&5bBXwQ&AC9TD`BURE2yxX5qFPEm(`w|);j6+)ktOc(Q^f4LJcvQLITkI)x$Nr7+ z7HB5kGtH>i9{3;G_`vn*FieZMrmh1$FNMtwJTI^ollG$QkMVEB*Bgfn2^HQrBt&dD zh6U~8!QczWVmC^=Q`-IQzI@L9oLr%?GUf0{?Gjd+)a!qevsmpo0Km7P= z*sxHQ`<3B$aBwxcBh{i=X`L|s{(<w|+YdX#(=mJe8mtOwYn2>dc|UqD4^F+E2O8xiU| z?55C9Lx+cG=uI##!z@_Y&gZ3%DsfKwN?p$TUQfIJP2r!1AG?N+C~0a8++k{@JJXH< z2NMzhaut7_1DyxS2~l})#-z*(s!UmrvELYLKcmOsIRW^CfggmC>x1|)4Sc#<#IfM( zIZ3pjG~j4Ke7HU3LujH6O^WS%!Nc=Px(pi``UFOY(}o_}^_CCK560%WF}l$k=^lJ< z`_9y+$N{@(7Gggum5dzdI$$nTPC%Ti%n2z$nq04tijs_Dj}|mx{8Zqt3B%WQAUR3* zp(=c}MqwSKl)+|Daf4dXBT;#FL}5wV@cfeX!wbNFzHP%%vTK~W+RLKkTwh)1i%6KcQhb6U><}E;X(4U%nPQuLB?ZI%KO+; zXpQk_bc$x-J>MTve-Heh6~6L;{cv=s<4Zo!{cwHo)#9hX{|!y5a@p_tw{sa;!wXC9 z96l;kcGD>ET?ms>KbAHwVQycokK5+y8`fVxr+pT<-wYpBaw+(CeLLI-ba(v*bXV#s z#GjOL{B_fL;P{(3;QVYJkLAb@Gigdg-|t({19;}VEA3fmpu*^bjxRdYeGo0GoWy=O zI6_j|lCoiLuPk)um4y6KkC&oKH=*@)34e;zre^w7RE>%A#Mo#tWe z-&4OY;=c#+CuO1oE=32-0p|r7i$)$0cb5b7wdaM;p^Hf)(H9S88jr~F(em<))aPkd{bZWrll$k^ zPXPZDfnBcfbstnd0)8|t$lM_FLgf6kj%KDcrD?IR`@CTsaZA7|xV`N3yon_rz$ou_ zn5pD8-MF9hb=$$Kv`Oin)B4|DQkFll^vS|WW%Uat9GUL`(<6A#^FV`B>Hhlv1PA2C zpE(d7n15FTIM(L|nV)4mMsn~o_H(YG8QzFi)@e?9Q+lBOcKASaAFj`)6?oytb(Z}wF{?|78Dehd(--7s)GUi{*I~Iil9*>fjITuK75FRRXLK)WYd3b&| zjy;;!*rK@^=`^Ro3V-}4Ilu47=s>uTxmo1|^pRX}S86%9pGJ42`R=!1POby|#V)??hiE`bUYqDT6ntF=;)ASD z?oNFK&oy}I$`VIS zJ#u4S?vWnCygRpHAH;tz%;sO>&!smXxH^Cys^Y<(8~%yCoYV0>Ng%^YdK7#8^BSH@ za~pgc72lW-JX&B4=sHmILfTh&mb}F8nIp`ZL#z}|E3*oVORdSXsm7?Or6+^GDd2w% zY)=eYC`X^qpqnN5+^}1wm!;=V4q8}SScNky4$-67K1NGhTHyag#D59mPtXA=4p;|D z3*gw*fTIN&hq?~@){6Wbc~AXE>E2A=_blMQ7Vzf+zg*!fKLj78(xUhg#RsKDN0Xuh zyL<`Hv?o&85&ycBRWyez@NZ3hm}-E_#+Vnnpd5?2;Yo139_3E(iu_Re9_lMm&O@I8 zuv3uhQwERTYk~jR$U6+ZFn+;*`bCKU|G~gN;;Wmh1BVC61yYI@WSyvTvz8a`#UAo~ z^?wWgjo#9Hto!DtcY+50rtsMZ-4DT6T4Wzs2QV+bpBC>;JAgUs8u(zuKT?gOXO>&w z-O9(BZS);fqhM-TZPbs4odEt%Kv@TNT*1`xTG!=&hqYa)1^%sZcOIF2J=1;CYf z9~&J{52rs!4uSzFHJNz`5k42kMt%KdTVhJ#5c>61)F}l9n|~phwcDBL3wtQpWMuISA7M$3Mz= z^gc7pZm^1GH*7@n%(<7QbwmEi7zQ6oBJlluh=wn@N#=&x4YuJKrVXBJ{}<>wtoJ~V z;~nqgjkD>G={pdAa?RBN+Pqq*YCP&WVNQbp;$BGinZKe$f5O;*JiQ+HU*lr4AA--N z;ENV?{CQ3;(DOk!ekt&0(qlRCv2RcgzF(CV|~7p4}^nQ)(G|- z@gY5!ZeH}kAMk9^V;NV$haX&Q_CvI&bPxq!@{+6#q_na5nc?3wH@zc0cI4OmhVcHX zo9Itib3dNZ2=RXt@vr1wbRZn)T2N!r8IxWO@L1I6Xq$s#n%l@Y_GlsAGdXEDjL-qjDII$7MFWx-!ZgtE5t^6byWjMyCg=z|M-TAd-fYwx8rTO8NEz!uESe5f zUIq`M0V#z8TMN6Phtn|rjdwzepuYu8a-o5*U3~UK@RcSVU7ED0&kbh$AJjALo6U^) z)xD9P%&bcb8odDiZSF+_Qu>WWJs#l$#|?PFLV6or!PZpH~&Hp;!IC8tpWWN(-VzK!|@&cd3EUe z0iONv-Mqy385^;uWfosG;@Nbo^d!dK!p3KS|Bn!VQt@XEh;c3uQ#wFh;;)ZK|M_7* z*6+RPE;IcK|H;NJ;lmb%AI*oT_?!#aI4{8}*9fKHKaUpu)^z*TzKs@U*8&HV!G9Sz zAbNrg9Q*Mgxj;(M0`o5#P-D{NVLd(Cs3E=W_x+y63G`Hxo9M~L0fn!8aPYl8C>?@h zH!o>gRQZVW68oX);E(AaLKiJ)etg~M6+1oG%0ld$ga2KKKPlt*i-`_&9>Q_~;vAs^ z=D@Wejz?haXWr|5wxdN)H*Em?wJtvU5e;9TpJZNOA4G>?IVqzI+)sffeBU#AV^W>! zv=ZOzf4b=ida7|LbYS!E)q$%4ColNU3yv0a9v;is3SL^{eS$Hpv>5Bor<-05?EMP= zDMy3igVF-V_(IMH9{eyJIM}R*aQu()Jb4!QH{w_KMp}}chUcLT^fb6<`aLZEcCr`z`lJD=N(Bhmrz<)j*U-LtJP&yEN#|Ir>w4m|Dze`EaHai~pb718P-|GY8N6SfGEkxqKi08_> z-g}SN@w`o6Tgd$vU<`hb_}lz*{3AGE9XKXB2+IjF7QvOw&-VQA4eIC9)8_A0LVLi^ z>;(KzT>NJpd_Nze;fo$+ZhE58e&F|^N8^wDCcV?r?AnO`!-zjAV-2YIvlcWxs63!) zKp&6Be84(TnpjLvHciH!o(bNfrOj#re-f}ODt!Qs^238KIVnts=&S2cd{H`3_-pV? z(S+Y8$A7{jKrc5(?$17jp3D4_c)+oYMJXlzRjv`5lwjRB zf*v(TnO;2w+&9Yr{u}hXgRgu5Ci@}yQtJ4+5578RQV!my(~8Xa*f&rB{%g`QjJ@YE z_BsAx9Iy`9e6+yv7ZV*wUgj}qbFz~bWo1JH26U`DSDcYRFJxT}{(p+V*R`l?K{Ozx z(gA!CA9O7&YVsL9lX)_2$TH$r=SF%Nd%Z8^Gywk_zyZ1TJdPz7NU3z-(SjR)a4kAe zT%d02paOGl5zZO+T4`IhMK3l_1pX3OIKHnI;RDZ0k`K6KKTPbC*;gU<2UPsSI6#cO97N=0hX>Jt;=$2^9s9o{_NPGu#xT>XSa&XOmJ943BJf{e zd}u@bf-t+`#mNC5c|5cJo`mxfapcUn)w%V^FdWQa5Ny}uu==< z7?%&xk`~6X&;HQLX2$@3KJd$9!q@dE{JU#K8 zHS3P}e@V;1`*KGEemaoYOBpdQMCjlM>7*71!#unsvN zu;Ezn^_(ENz}Dbi%oBaVzY)JWH!AL5!Cvdj%^pVlD_}PNE(ZoJxcLC_SGn24f#LyU z&|RlxK8O88-#?rN{%e8%slYB*_^uDQzT_jL4jA8{0bK{mhs+Jw(=z{3L3Jh{_fDVP zW?}B_L@#Im3r5N~{w@cs2gI0-Ina5~bs)JwACDaSrJ4I^Y1WmP`_1q8SKyiR)fPF> z;dU3F{fO`ZZ3^EhWo~lUDV!5DtIP>yz#joE#-I5NTBnsAYSOFCrX&6pFjD5#fzkqN zz|n&65WxZZC=R4#KC)I~Pay;R8_=P@SDGh4e>cI0(&+e%?U>-}TGVwQIl=a2D|~1L z{*Cz6xsl$)yt^VNn_g@7A>vQUL<3UlV^PluiUUtRa5+Fb&kHZ$S>lE4k@TW@uZ^}| zjCEg5D)2W(#W(ukV0-;=bCSX@g%49<#@{Ka&fN38)7o|k^m_9`#6JMD`S%d(n7__h~YbW^k-E5)f6D@i@r!TE&{*%JjeGvUgY0OEI6ErR8IcZteC&2Fn z{;NCH5%*84a(L`DLG0JSNZD&Bbq-hyD*lMGmj@Y>l9Q#B@whCjoR(!zqUAZpd6(8Q zeyb#Uy~T4bKKsG=%5dyzF$#W!7SY%Cp#tT@w7mHd`+MgRLH#dkpf|AJ^G43q82@`= zHvggnod=f#T?>eDwDG9opS>G<3Mb?D#f?#+58JW+E~1q!zKV*k>rpiLir{l@!m;Ef z(V)Fv{Q>84=_B*^i;PZHqefbdvG+!c7ZHD=mEfN>AQnvrZcgCXJMs5wVYzyaoDE+5 zf1hi0i{pX+kc+ST5QY!GbPeeEtOvnnUqlCXxfnSM_ZZLpURl#Be79~@%dUw39vIOZ zh%v`s=O8R6Ahy191I~r`~ZF|N)nci&iZyTR|aCE5qVA6ri58k}w z>OkTDi2bZvYXK(lj~tH`7?Vrrl^p;5 zo^>5-(CQY`;6s_hkMN-?Ejm6J{Q&>3G+RxtwTN%@8`Mr4@XWU+=PbnkpNKyx%Y5JmpaD`QI`s1)>fFTmVLp5Se=_lGVZ^V_jkKvX;@_$jt!=pr@h4@%0hhvq zt^?76J}*Sf(cpcB$_XJn%iTz?wleSa?!wq#*Qybo{nonpx*vjX)B*Hq(xS>qj1LX0 zXjYDL5^{fh@Ee3q@3c(-|9RlQ3>=U$i9eUF23QM@9z+W=FDM=GyugN-OHQ_P!e-Q4 zVmunqvF-@r9sl~4eSmww#b-anhiLesL-9kjpyR*Z{9|b3Gd##vzPM{4fmq*1H9lBb8&SJ|4<dv$2{#EYZ(CP;8zZXWzSOdBa^l=!b11A^w@nFx-AJdyT9iR&nyhWR^?%dewBJlrB z1U~Cgbhs8inf&nPqp*CydTjm`_LI)1*RzfI)wz*E=Uenvn-s)?2R+IQZ?+;bep|HJU1T>0SVhu}-8@SzXUBV&un++>$8(5hB- z=-qRwGu6g>r|HLG{I$LW@&A@Kg5!;?C@Ke%6LbyeJV^Yde6z*382epl<9%lQcd+i< z)cQ=||5IV>_BL@>Wu=!^WSPL5r zTHx6G#a}eR&yJOI^dcN5Vg5HpmELVri{5HI1wK?n;Okm2(m;x8ixCIjw75O&C46+oX5fwFLj$ z!GX=aR|C2Z)SLhg+_?cf>*FwNEUIxC#QEX0+W#FJZE0H{_^TB@`{4TFXmAtSBo|33 zen?I-`M}Q!>spoqe+s?V*|^_yaFP1o>rI>So^5lR0hoXHfdf1CVH`M`@XZIF@hCi0 z=7Sxyp*4QFl8nKl_uE+XZrh9Loi<;&_~M7?kW0b$)1t}+jxXYaUGBzyRy%sDy%E2< zH-i7;Xmi^K!9S_^bL^F&9;*(*)(9ALm3g@WYsZPSKFTxS-|@`9x$QXMSJ1nREq-YD zZa(nQfj>U`@*r|Ye80y>=qmSaY4a*_04Z~IAUq)E5jwy)Q)ANMLvnH?4}Syy9l^g3 zI`(^awy8~9+RP5aXCGWYG<;VF4!)ij#0Qxd?6u;T!0&3#Jiabfs}r=fZBxYmZJ5o! zt^=0?M+>3@mj`h37PyeyEF9Q6D90M%0or&{)W4lY@3lV>8hpYRU(X3feAb|^4i{m~ zpF~^De@CEN5$$uc^j_P>(7;9&f7XB)>p;e#lt*-+AQSqz$N!r#v6&iRE9FT3A2K1aD8c^dA zJV)h#bv)&bfHvk-fo`7$ z|80T2GYmh>2f;@vbAqb_2RB>`Td|+n4EaAM{OaC`cAV4@^YE&O_%jDC53B>tB6x7e z~z}M4*2b2xz%_d zLj)+$+rr$5Jka47>KE?`Zrh!tU|ML9RC20R>DT0Zw76}JKU{@&b_#UbpY}J zbg&I;(rxXA0A~qoH>?!KxNJN}eT4H*W6rn^<2?myQ=Y@*GV$^kL;(CF{)p!e?9FX& z*A{W^37$uxoQfFVhH@Ybg#@PxzzJtF9@HTwej9kO*ym#@pF20|SpZMhwAUccZ1H@bH6FG55j{e~2 zK3}Qz;STulKJ4RzUtj+6NW`xYk3c*E@d(5t5RX7S0`UmMBM^^3JOc3u#3K-oKs*BR z2*e{0k3c*E@d(5g0qn0=)1M-uvMizsD@g@lcTFO;poM?%vn~NbmZFgT-38*Ru<}IDA>5p08Tv#rFAUoK{Pw20KN4eao#Zto{+b`+jE}l zjwy%Nq0WXjzj_wVXUX|u9J6WlT-0-=ZsC~Cr_Q%I8CK++H`Td~_&n~1!@$P(<L$84&uSaIrT(&wP-FE$0V$dwR&TY&g*Vj4WAu3jUR@Qe* zxKw!f%B%&viDf?u5r~DR#qS*R9C9QjdHd=Zj#u zPF;n9+qC**t?sJDId7=j>T%8=LU?R7IiKGh86F-;Zn)M}5uRfE_T6wf^(^P|x_VTT z6{#K$Pm$A~!=s18TQ`Km9$e1nasIG}hZW^qo_5>e@YdbiUsr{Ca6U{;sOPfD^-cBN z+Ibuou}Ob#9lmmckkdHkyy6ZX + + Created with Sketch. + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index cec1d27..863b076 100644 --- a/docs/index.html +++ b/docs/index.html @@ -8,6 +8,7 @@ + @@ -21,10 +22,11 @@ name: 'AntD Admin', loadSidebar: true, maxLevel: 3, - subMaxLevel: 2, + subMaxLevel: 3, auto2top: true, autoHeader: true, repo: 'zuiidea/antd-admin', + themeColor: '#1890ff', search: { paths: 'auto', placeholder: { @@ -35,8 +37,9 @@ noData: { '/zh-cn/': '找不到结果', '/': 'No Results' - }, + } }, + // homepage: 'https://raw.githubusercontent.com/zuiidea/antd-admin/master/README.md' } // if (typeof navigator.serviceWorker !== 'undefined') { @@ -47,6 +50,7 @@ + \ No newline at end of file diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index 3a988af..9a94d08 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -1 +1,79 @@ -# Antd Admin + +

AntD Admin

+ +
+ +一套优秀的中后台前端解决方案 + +[![antd](https://img.shields.io/badge/antd-^3.10.0-blue.svg?style=flat-square)](https://github.com/ant-design/ant-design) +[![umi](https://img.shields.io/badge/umi-^2.2.1-orange.svg?style=flat-square)](https://github.com/umijs/umi) +[![GitHub issues](https://img.shields.io/github/issues/zuiidea/antd-admin.svg?style=flat-square)](https://github.com/zuiidea/antd-admin/issues) +[![MIT](https://img.shields.io/dub/l/vibe-d.svg?style=flat-square)](http://opensource.org/licenses/MIT) +![Travis (.org)](https://img.shields.io/travis/zuiidea/antd-admin.svg) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/zuiidea/antd-admin/pulls) +[![Gitter](https://img.shields.io/gitter/room/antd-admin/antd-admin.svg)](https://gitter.im/antd-admin/antd-admin) + +
+ +- 在线演示 - [https://antd-admin.zuiidea.com](https://antd-admin.zuiidea.com) +- 使用文档 - [https://doc.antd-admin.zuiidea.com/#/zh-cn/](https://doc.antd-admin.zuiidea.com/#/zh-cn/) +- 常见问题 - [https://doc.antd-admin.zuiidea.com/#/zh-cn/faq](https://doc.antd-admin.zuiidea.com/#/zh-cn/faq) +- 更新日志 - [https://doc.antd-admin.zuiidea.com/#/zh-cn/change-log](https://doc.antd-admin.zuiidea.com/#/zh-cn/change-log) + +## 特性 + +- 国际化，源码中抽离翻译字段，按需加载语言包 +- 动态权限，不同权限对应不同菜单 +- 优雅美观，Ant Design 设计体系 +- Mock 数据，本地数据调试 + + +## 使用 + +1. 下载项目代码。 + +```bash +git clone https://github.com/zuiidea/antd-admin.git my-project +cd my-project +``` + +2. 进入目录安装依赖，国内用户推荐使用 [cnpm](https://cnpmjs.org) 进行加速。 + +```bash +yarn install +``` + +或者 + +```bash +npm install +``` + +3. 启动本地服务器。 + +```bash +npm run start +``` + +4. 启动完成后打开浏览器访问 [http://localhost:7000](http://localhost:7000)，如果需要更改启动端口，可在 `.env` 文件中配置。 + + +> 更多信息请参考 [使用文档](https://doc.antd-admin.zuiidea.com/#/zh-cn/)。 + + +## 支持环境 + +现代浏览器及 IE9。 + +| [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | [Opera](http://godban.github.io/browsers-support-badges/)
Opera | +| --------- | --------- | --------- | --------- | --------- | +| IE9, IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions + +## 参与贡献 + +我们非常欢迎你的贡献，你可以通过以下方式和我们一起共建 :smiley: +- 在你的公司或个人项目中使用 AntD Admin。 +- 通过 [Issue](http://github.com/zuiidea/antd-admin/issues) 报告 bug 或进行咨询。 +- 提交 [Pull Request](http://github.com/zuiidea/antd-admin/pulls) 改进代码。 + +> 强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545) 和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)，更好的问题更容易获得帮助。 \ No newline at end of file diff --git a/docs/zh-cn/_sidebar.md b/docs/zh-cn/_sidebar.md index 9891638..0365538 100644 --- a/docs/zh-cn/_sidebar.md +++ b/docs/zh-cn/_sidebar.md @@ -1,8 +1,8 @@ - 入门 - - [开始使用](getting-started.md) + - [快速上手](zh-cn/getting-started.md) - 定制化 - - [配置项](configuration.md) + - [配置项](zh-cn/configuration.md) - 指南 - - [部署](deploy.md) + - [部署](zh-cn/deploy.md) - 更新日志 - 5.0.0 diff --git a/docs/zh-cn/configuration.md b/docs/zh-cn/configuration.md index e69de29..21bac25 100644 --- a/docs/zh-cn/configuration.md +++ b/docs/zh-cn/configuration.md @@ -0,0 +1,102 @@ +# 配置项 + +你可以在 `/src/utils/config.js` 里做一些自定义配置： + +## siteName + +- 类型： `String` + + 配置站点名称，应用到登录框，侧边栏顶部的标题文字显示。 + +## copyright + +- 类型： `String` + + 配置版权声明，应用到登录页、`Primay`布局底部。 + +## logoPath + +- 类型： `String` + + 配置站点 Logo，应用到登录框，侧边栏顶部的 Logo 显示。 + +## apiPrefix + +- 类型： `String` + + 配置项目中接口的前缀，接口相关文档可查看 [接口配置化]() + +## fixedHeader + +- 类型： `String` + + 在`Primary`布局下，页面滚动时是否固定顶部。 + +## layouts + +- 类型： `Array` + + 配置哪些路由使用哪种布局，未指定路由使用默认布局 `Public`，项目中目前有 `Primary` 和 `Public` 两种布局， + 默认配置如下： + + ```js + layouts: [ + { + name: 'primary', + include: [/.*/], + exlude: [/(\/(en|zh))*\/login/], + }, + ], + ``` + + 每种布局的对象属性如下： + + - `name` - 布局的名称； + + - `include` - 指定使用该布局的路由规则列表，规则可为正则表达式或者字符串； + + - `exlude` - 指定不使用该布局的路由规则列表，规则可为正则表达式或者字符串。 + + > 注意：`exlude` 优先级高于 `include`，后面的布局优先级高于前面的布局。开发过程中可能需要结合`src/layouts`目录下的布局使用，具体方法可查看 [使用布局]()。 + +## i18n + +- 类型： `Object` + + 配置国际化，默认配置如下： + + ```js + i18n: { + languages: [ + { + key: 'en', + title: 'English', + flag: '/america.svg', + }, + { + key: 'zh', + title: '中文', + flag: '/china.svg', + }, + ], + defaultLanguage: 'en', + } + ``` + + ### i18n.languages + + - 类型： `Array` + + 指定应用支持哪些语言，每种语言的对象属性如下： + + - `key` - 语言的`key`，应用到页面 url 上以区分语言，也对应 `src/locales` 目录下的语言包文件夹名； + + - `title` - 语言名称，在登录页底部、`Primay` 布局顶部语言切换显示； + + - `flag` - 语言的国旗图标的路径，在 `Primay` 布局顶部语言切换显示。 + + ### i18n.defaultLanguage + + - 类型： `String` + + 配置默认使用哪种语言。 diff --git a/docs/zh-cn/deploy.md b/docs/zh-cn/deploy.md index e69de29..c2e4355 100644 --- a/docs/zh-cn/deploy.md +++ b/docs/zh-cn/deploy.md @@ -0,0 +1,11 @@ +# 部署 + +## 本地开发 + +1. 静态文件编译 + + +```bash +npm run trans #可选，提取翻译字段，并自动翻译 +npm run build +``` diff --git a/docs/zh-cn/getting-started.md b/docs/zh-cn/getting-started.md index f8f045e..649ab5c 100644 --- a/docs/zh-cn/getting-started.md +++ b/docs/zh-cn/getting-started.md @@ -1,87 +1,19 @@ # 快速上手 -> 在开始之前，推荐先学习 [React](http://facebook.github.io/react/) 、 [ES2015+](http://es6.ruanyifeng.com/) 、 [Antd Design](https://ant.design/docs/react/introduce-cn) ， 了解 [UmiJS](https://umijs.org/) 、[Dva](http://github.com/dvajs/dva) ，并正确安装和配置了 [Node.js](https://nodejs.org/) v8 或以上 、[Git](https://git-scm.com/)。提前了解和学习这些知识会非常有帮助。 - -## 安装 - -``` -git clone https://github.com/zuiidea/antd-admin.git my-project -cd my-project -``` - -##目录结构 - -应用的目录结构如下 - -```bash -├── dist/ # 默认build输出目录 -├── mock/ # Mock文件目录 -├── public/ # 静态资源文件目录 -├── src/ # 源码目录 -│ ├── components/ # 组件目录 -│ ├── e2e/ # e2e目录 -│ ├── layouts/ # 布局目录 -│ ├── locales/ # 国际化文件目录 -│ ├── models/ # 数据模型目录 -│ ├── pages/ # 页面组件目录 -│ ├── services/ # 数据接口目录 -│ │ ├── api.js # 接口配置 -│ │ └── index.js # 接口输出 -│ ├── themes/ # 项目样式目录 -│ │ ├── default.less # 样式变量 -│ │ ├── index.less # 全局样式 -│ │ ├── mixin.less # 样式函数 -│ │ └── vars.less # 样式变量及函数 -│ ├── utils/ # 工具函数目录 -│ │ ├── config.js # 项目配置 -│ │ ├── constant.js # 静态常量 -│ │ ├── index.js # 工具函数 -│ │ ├── request.js # 异步请求函数(axios) -│ │ └── theme.js # 项目需要在js中使用到样式变量 -├── .editorconfig # 编辑器配置 -├── .env # 环境变量 -├── .eslintrc # ESlint配置 -├── .gitignore # Git忽略文件配置 -├── .prettierignore # Prettier忽略文件配置 -├── .prettierrc # Prettier配置 -├── .stylelintrc.json # Stylelint配置 -├── .travis.yml # Travis配置 -└── .umirc.js # Umi配置 -└── package.json # 项目信息 -``` - -##本地开发 - -进入目录安装依赖: - -```bash -npm install 或者 yarn install -``` - -> 国内用户推荐使用 [cnpm](https://cnpmjs.org) 进行加速。 - -```bash -npm run start -``` - -启动完成后打开浏览器访问 [http://localhost:7000](http://localhost:7000)，如果需要更改启动端口，可在`.env`文件中配置。 - -# 快速上手 - > 在开始之前，推荐先学习 [React](http://facebook.github.io/react/) 、 [ES2015+](http://es6.ruanyifeng.com/) 、 [Antd Design](https://ant.design/docs/react/introduce-cn) , 了解 [UmiJS](https://umijs.org/) 、[Dva](http://github.com/dvajs/dva) ，并正确安装和配置了 [Node.js](https://nodejs.org/) v8 或以上 、[Git](https://git-scm.com/)。提前了解和学习这些知识会非常有帮助。 ## 安装 -``` +```bash git clone https://github.com/zuiidea/antd-admin.git my-project cd my-project ``` -##目录结构 +## 目录结构 应用的目录结构如下 -```bash +```text ├── dist/ # 默认build输出目录 ├── mock/ # Mock文件目录 ├── public/ # 静态资源文件目录 @@ -118,18 +50,24 @@ cd my-project └── package.json # 项目信息 ``` -##本地开发 +## 本地开发 -进入目录安装依赖: +1. 进入目录安装依赖，国内用户推荐使用 [cnpm](https://cnpmjs.org) 进行加速 ```bash -npm install 或者 yarn install +yarn install ``` -> 国内用户推荐使用 [cnpm](https://cnpmjs.org) 进行加速。 +或者 + +```bash +npm install +``` + +2. 启动本地服务器 ```bash npm run start ``` -启动完成后打开浏览器访问 [http://localhost:7000](http://localhost:7000)，如果需要更改启动端口，可在 `.env` 文件中配置。 +3. 启动完成后打开浏览器访问 [http://localhost:7000](http://localhost:7000)，如果需要更改启动端口，可在 `.env` 文件中配置。 diff --git a/docs/zh-cn/router.md b/docs/zh-cn/router.md new file mode 100644 index 0000000..f511c2e --- /dev/null +++ b/docs/zh-cn/router.md @@ -0,0 +1,5 @@ +# 路由 + +本项目中采用约定式路由 + +参考[umi 路由](https://umijs.org/zh/guide/router.html)