From 31fb28e17fdf9e3189f59c84e2063345a7fb264f Mon Sep 17 00:00:00 2001 From: chenkening <1647973814@qq.com> Date: Tue, 22 Jun 2021 15:49:17 +0800 Subject: [PATCH] docs --- doc/.gitignore | 17 ++++++ doc/README.md | 8 +++ doc/docs/.vuepress/config.js | 14 +++++ doc/docs/.vuepress/enhanceApp.js | 0 doc/docs/.vuepress/public/logo.png | Bin 0 -> 8383 bytes doc/docs/.vuepress/styles/index.styl | 23 ++++++++ doc/docs/README.md | 25 +++++++++ doc/docs/guide/README.md | 25 +++++++++ doc/docs/guide/deploy.md | 44 +++++++++++++++ doc/docs/guide/devdoc.md | 1 + doc/docs/guide/directory-structure.md | 77 ++++++++++++++++++++++++++ doc/docs/guide/productintro.md | 1 + doc/docs/guide/question.md | 4 ++ doc/docs/guide/quickly.md | 34 ++++++++++++ doc/package.json | 18 ++++++ 15 files changed, 291 insertions(+) create mode 100644 doc/.gitignore create mode 100644 doc/README.md create mode 100644 doc/docs/.vuepress/config.js create mode 100644 doc/docs/.vuepress/enhanceApp.js create mode 100644 doc/docs/.vuepress/public/logo.png create mode 100644 doc/docs/.vuepress/styles/index.styl create mode 100644 doc/docs/README.md create mode 100644 doc/docs/guide/README.md create mode 100644 doc/docs/guide/deploy.md create mode 100644 doc/docs/guide/devdoc.md create mode 100644 doc/docs/guide/directory-structure.md create mode 100644 doc/docs/guide/productintro.md create mode 100644 doc/docs/guide/question.md create mode 100644 doc/docs/guide/quickly.md create mode 100644 doc/package.json diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 00000000..ce0ed8d6 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,17 @@ +.DS_Store +node_modules/ +dist/ +../.idea/ +npm-debug.log* +yarn-debug.log* +yarn-error.log* +package-lock.json +yarn.lock + +# Editor directories and files +.idea +.vscode +*.suo +*.ntvs* +*.njsproj +*.sln diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..c3d2a4c4 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,8 @@ +## 文档 +文档基于vue-press实现，运行步骤： + +1. npm install + +2. npm run docs:dev + +3. http://localhost:8080 diff --git a/doc/docs/.vuepress/config.js b/doc/docs/.vuepress/config.js new file mode 100644 index 00000000..c3e920ff --- /dev/null +++ b/doc/docs/.vuepress/config.js @@ -0,0 +1,14 @@ +module.exports = { + base: '/doc/', + title: '大屏设计', + description: '使用拖拽快速生成动态大屏报表', + dest: 'dist', + lastUpdated: 'Last Updated', + theme: '', + themeConfig: { + logo: '/logo.png', + smoothScroll: true, + sidebarDepth: 2, + + } +} diff --git a/doc/docs/.vuepress/enhanceApp.js b/doc/docs/.vuepress/enhanceApp.js new file mode 100644 index 00000000..e69de29b diff --git a/doc/docs/.vuepress/public/logo.png b/doc/docs/.vuepress/public/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..980ed0fbb0e91cddd19ad4d367908d19f90e5d0f GIT binary patch literal 8383 zcmV;wAVA-VP)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGmbN~PnbOGLGA9w%&AXG_2K~#8N?VJa6 zQ%BynjisyRf-!{VCR>u_hATEUV1sRNk*)56fdESly%_?8mIfq1s3E3f2r(t}VnW(x zQ^+QykZcNUfRG9)gzUQ|-)=VV_q!T-G#W`R1io*R%{kA}xt=?B?#w**Kjlitev+=) zZKszHxNN@?WS!fFq-#$fxE0I5WutJ}oXErbQrPsHbNSx|r>aFflu+D?W#F<=xNJ_O z-Et^w`c1j)lH(mN+ph&qRf~8ip|};xz-6Ow*_<@zQs~~hO-Q@;1+wnBvamd5M7}(% zpU^EADO|QT!Pbd|%SPd{QMharE?b-6RJDkQ5{g@~3|uw}m#qc-;FfE4i%7fX3Ele1 z!}1m31**sa_{5)LqDRiw!&QsIWuvgqCJUF1!WG*lI8`m;p@iaAECZK~!ewg#KUr8G zuGuXj>sBD|UZ@BgpbQ_ViYUT?&^2G$r9YRgO>otsaM>uRwpX}p6t37d!KrEy46fRo}_{qa_h3@DAFG#!hr3hiU6e5zi1UP_Q=w$P_UF%V@C(^D6cQ0_+D6+7= za?~W8Aq-r#Xc3`H+mLk4^nqKk3|uxRY@J(!ADQjE;@>@=A`LI3z@=B% zJnXexv9}6Y_dHZy5#Ar*0Dp2BSeGmwUHKmhSM3(L8JDs!@348;Yq?@?6~DRUxEYtN zfxVV1_EzzmOAbH2{S2HQiY#&k@`2GIbGlEfmhs8aV2iq6NU zJmR*D$y`yl6+dyB@qsivUm5`lgvdf6sz^Wxs*8o_5+SBop)&-tQCTRWvybWF7eCz@1xgEF>Mu7S}K1Zca6LVQxV zFr`Ss`r~ntMIz`ih8HmOqe#P1J&Jqvyy4#+OExE5x+F|2L5RRjUFq_u0)@H|pE%3L zw;LY4<_YVPJN5qzag1f#=1v}3E<_c`)EHMw1cyjLXH>}qe?B%R+qR1MB)<}-2Ab4^qMFC5iTWN`mk+t zCtr+`sDa{QC&nPtlnXkuEY_mb8H3`jp~+R9(+771+XdOJJNeIKfW9u`1TA&>A5Uiy(}~tVlo?O@MVN zizrb<8C22bff`eY-WII01jHDX>N0i><$kSO^qCq{|rvP>3jlxZx2)-KaksC3qVSX)qBMR0s2K5?wnTI4aNw!1VaqRLg#h)7F_ zz9JY;NsL*kHsYp;S46EeY#0Yws-&mx7tC`{)CvMAR|m~D$su+a+7$10iw z8zdJPt|;Pu#tT9>??}7%_6pbaE#pyg^Y}R)QYKcI7-|8t3hKjxcBUGvn6mHPx=}VVV-8FK6?!vCD<5SNQO4!auCH zS9nz|;!$$*_&KWXY7g5lzFbQ67Q%ojE7!dI;m!}Qg8KKrjLsh;*OU>Y>Jkch$wwgX z{|MTF6W70TVb=#&!RSZ!wd~S;=%%oBCQZ=fj~=^f&-#}?c>Mge1E2oo*jGQC`1YTK zZP?|!!Y^qa*Kmod%%g}ZdD)M;Z{+WqXwZ~t}rFaJvz zx};vNDzODOC(DT^wh#2cpVz5E@ycKX)FR=D&ITj%!i=JFYj)cx_JBVYdgsT)7h zx_RaJ*Z*hs&eKfuf8j1sC#EqX;@fk_ZlrmaNfoo#ow>kv&5l2PA&WH%I&4GBB^m=o zsxI}4yUUZ(s4^!^OtVO$+&~F}W3xo}Fn6R>j9R|?;Aj7Him}*m>D%Q`zcsJn+1Wc! z&ENO@BhQ^fq>@u7zWvwyy}xJL?sC~0*mu7y(uls4Uxv#;57zJh;HmF_O0StK zjV%ZMS_4IjLcGytmyre*u%tpf#v8 zr49@MIzzDDm};IjW9x}M7r*_@rMXkih((8AA-%T!z0WaNk>h*zzaY_ zrR^@uSfo){YGF(^p{iKLU}$ap?%$-e!(aY=-0HoZQ!B-n`|hoy2$2Iir&VR+;d3SO zwwj0a$MXNpCF&$#RT)!^g^7Q}07+z#6#D^jS5WG6?V~g2j#;w#tt;p?#A3zbtsDOM z(J4niLTX6Q!ID^$f2@%r(VE>r39%L-)|ya0ow}U1wNVm{S=K>J8O2|1ph%fUfg~>&t)$c*SR) z1cW1IdV41d_u{D_>u`-(yH3Wn-thUJF~fB zltqZh57ZThCK=Uvcg7cwjVl@xl{>UUqA@^QAVeZq`|vbf6`(B&Nht4>Vu>prOD>G; zOD-&C--NKgzhUtU&=dtHnnF`-s@QTN8ai8c8CO1i+3B}P-_6_iLbtx7G{ut|KKh2F ztb6&qJi*4gWFeawS-ef2U{A8t?)%v;QD;rzU0Cmk<$V9s`d7}USI+ia-%?2}f)Tr8 z4;#kb8QV_O|LL>F>pzkjf}_`dSlak{!I=9(;?0iC&dy~~#SGN+A2D`y1FprOMJ{ao z?#E4MFV@^!7nV~cSNCTJVUh5D!Fq$XVC1kR+t$AL9v(+}N8Ek$o0so=a9j7RYFQKp z1MwD|LW*B-Y-vajOUG2ZQdicRxRmQH<+C5fssVR8dHu)InQH=)Dv^HwiPy<6d+gc| z@wQq|e-uO{L@E+1lB~1#ef)D>Dr1f2yVsFIFv3sSd`zKp?rLt%Wkl~gXV;&?mWGt+ z$)PX)I_8mv_HicCvn)aSl7i8Tx4d=v)D7p%&2sYkzg9f+X0mC5JQ_N4U4-|mn!lmp zqpzuZ4%mI**cr%{I--+PNbyss3srgphFQ7zQx7pNo7RVBuP*QCHGKN^Q{=8&&wZL` zsU_(p(^emItbibR!p388#_FVyh*Tz3f)x9leIMT-)kT@~7MxBBXOR$`XkBpNMN-JF z_rENjyqun5UHXExNK$eJ&#Qa=Bb0XRs~<22Bc9g3^5MFdK0tgN{_=0+MhzFgG0t4& zKJMizq6ZXBcyQ-?UywXd4yo&2djHWg=Mkf1fsNJK!>7*14j4r*BrHAoN1R14?Em7;hcEa|Gm@m=kv;tJ3tuA<_r}ULH0w^zA^|~3bRsU3ZFkeSylIymQY!2J^f@U6ogQzP zOixi^&A|2rNr6k0v;Cbq%P_9_Hl-YoEqDlwL9MZl(cU18<+YHo7bF6Nq9fMuslC}h8OsS z4`|*chSNd!Z9n>z*q$R-|4}sc5oNrco}IDtG`TCPTQq$&XVD3USy3m3Sz8aAYmB{V zmmSlpkA3Cb5iNh_?XFov=qV~p8B-G3XSgLJ7EmAk7KZh&<*)&UAJ)vi40m_ZTfL+;<~NO!9hMckA4hxPLh@9!T`=pQb|r9@qZ zje#`A43X$Tbgm3r2uCkR51g>@z)Pe;t6zLS-cl>Ybl613&;{g$3x?UnN6sMfc#%zz zi8Ik!%etiHu>M&5qYV_gY3bN=2q^(9Z9E&)!|oqlLJ*>`(Guy9WS{id;roufOt_a} z#`Y5_*6EVSfq;Cg6Vk)hKFKC^?9d2wW21~NF-%!b?zQW~t0j|`(fvuUL3eL>)%g~z zc1L5U6j*VF9YGmgoHKMj3F{{=d}W-uS|)z+AXZNjS=hN}l~PxV15aWKNALXLOI(GB zpImoH7LBT6>*xjYZe6U6B%)B#^gs~aQsrTR${?)LqX^S#g=!;sMZyXw$660 zvl{;VwW)SBjfp{vHj!6@m{YL^#z;WJjuKNacFS8IBM&COkt-XpIzinWw{w0;z#`L> zgr-(Rl=d-%v?@N8(enmIds(O{Uq}CUcO#1d4&*fbqR1VV%1)9 zR}8bmmp5={Iht`9nLlpCiaj&xPqECbe~J>=qtesm!%x2z+Ox*fWvBE(YhHZ+(C2@p zkoW+;T*@?MQT;|`51Eg}RMmpI(JP*qzV*c7gD+xLLM~)os$xo~)Ey!{v+vTkgYVs1 zG=8ZkRSP$5JNF5>eCn3tD!rL?DODGB$*f7Ms4W=xpmomrVas+-syj4q&vPrEJLlYS z!R5|V?USq|zbEc49cv$7E)z^MSH18aDHQQH^r6T5jbFwwd_@DvfYrf@=id$O<$VQ2 zXvSr7#ob%ZIp=(@gk}sOE^&b8h9s{3!+TMMV?133#F-24T56uNo?y9q{nV|;$t9jH zg&0GeVe;Vnw=X>SQr+tpv1C2&cq_uey6l`i|c?NbL4m+jMP9(&EXuHO9imFy9VJY8~NaO*o_F}Z|wiBqzevaG@P+;{X078<9& zcQyoI{M>f#(^bEJ7mo``flJG*HDvG%&mOwyN$0wzmCW3M2(y#>s{4V`8HRz3eNT~&~{6o0Gi4bi0#Q6P&fRA~(%@wU+9>fppG$m8O&d+z9& zJD;X^Y7MB(wCzuMj>D9+ntS$LaemV>X8l2$j+;VNoN;Wnfa}tjC=d zJMh_GhCQ@Psx2emwTZt2ZK9Pf^`#RRAAaTdH)8Z49I@aW^~fI6j8z4r@9$MJ7famI z$q$nYS(jnGhA!Oy0!?4A|MxR@G{OJZ*6g{NO4nao?32Ti&|j4FYJx>uZ=7C=M-NF6w31t|p2^#dng ziz*x^)nY4EuF$w>jY|Y&!k1&Tp}p_(Gqp3Olwr?ErE%ZD#w=5KgKA*T2cH?!`wc-ruu;$jo*oHCJ%o8Kcm(@ znP8g*6792D;;pryN9CLcPCD=1aOt{j;btm{W6%TjbYdu&w47{I#1}@oa!IUFsy7OH zlPuosBF-#eFQ_+3V~vtnIld?-R-v$3ez^pfcY{sr9!GHmBf_# zM;EtK7vq!Shtbs!EpfaPKsYMmZ1}{n_|!LbdPLz}4?XiXDGqa0`rrlVaqc zk$go;2~MjSykr+C2aCy#Z+x6TX*qVcUgH>`b$v$OPx3olK1|;CMiz`)c<5!4e(#Z2 z!~0QROVBlM)Q+atl67Yulh>WU`?4?I%9aC>ZE}fA@F-*rTa48_DX{UofA9a~`-KNz?tj;^ zPFZ(~(|=RDI%khC%v`g+>6c2Z%aHWJ)3!H~^b_CyYvk&EA!*pHmXXy{X3e}UZ(pH{ zTh65_);M9qAuRWB>eP*YZ+P|3y@t#eV#rs*A~=r79XV=6!@8G0wB1ujUE1b7M!s|c zSZYP&{tk)aCF+tcSwrUSd7f@#0C7o0A~fAxO4V5MIorwO==aFN@n|q9>ya1U!!$|K zn*qaYYRx_5Cwhpy`%k={Ts?R4))Tw`{LQ1UeN=b$GPWXQ_62osTnb99VO>I4+i+Z^ zO0LQsw~USl00TIlBn*8Rbyqz1&bpV+Z++*p{a0=v4(RG1O)H$VoU~V}Guanxda~)4 zT^NdR$;7&&lj@E<{PbIgKL0DOqPsG<#6A_lO1d7OvBeXxX(1yGMq2D@*1huKlubv+ zuHBE%hfcqNnqaiVXZ7MOL?lQkn?eH`eS&?+>|IZfU9*4A6VE(;{u=raiS(w9{Uug2 z;;-WfWW`SK^H*cobyrA*KIsoU z8!mo}SfnlyuXirp`Q#_g2k7+oKjDeNCFE&4{KenqJn`&9r{5%JiA&ZWi(fmnYh2~Q z0Gm1V{^PHS9dYBQogZE^%v#3^YX%Ie_C;IBg@_NVDdz0`J?Tv+H-1|2{JWacDcnFU z!l`Nz_scPz7foM<2@hK%w>wg9{B-d1zrtD1!3(&l6oloCnZ5hjBiH`HU4;QQ#WFK{ z@O;v!CoX(#ox4GyEthM=L72LU%o{a#&vQpTE(Zv*N6%a+xNC{reUB8BU_+$ty>#6z z|BavaUH%Tkcx3LVrH!wXo6f2iU9#h#N`noijxy5)@qck~{i zOm0+vaDkB{GQ$TWMMwsazHgzW@}RAT_$dJij`xq9NJBe(>V&R7+a zRwaJhqb=)@F{o?KFc6Yjh5T67P$U``ev%lQBnCR22wFSEL(eUSS4d$zwa%prX@c1+ zez9fku$V$2i569YH89BzaKNtbxgVHO$W~32P!W(=32=Zv<$7EzzP=zUN49@`#Z6mb z%VA+h5tjcJm;P}^K=NQs4~qZ?tV^zX6leqR2bA%4Dw1`HPl|iL^M+avTMi5BkLAC` zB{@rs3UMYyf(76}&>N+(W*3PT7Z?dJFvJ*FLJ+%f- zNfVqx3YX0Vr;y@dt9e@EQju(<2&vu)NU>8CNft_LTw+9}xcT@wc-U$lKY470_}@WV z;`X_eCy2j$c8R=oF4^@U>&$m8RS>m+ZCNDX;L|tla3!C33TvvL7?JprwoGCH$DO0Th>DIsuOHfa1aF(@Gc4cUGMM#z{DAO90Wm9EY z#n8+&D>Cd9Ork<67PlsV=KzJEDE2`C?0q>66gH1UUxr$#P#-*7J;df9Ma&bA<~!kf z#w)&j!KIsj_8g~>;ufO}Zuesxu<5>F^ZSJ97hm{t8JJ-cMP}OC_p;uRUDYY4DzsNc z`z(8KFMB{QQKury!n%~F+n`gLV!nkg@h9RNi)84;Cu)ckaSg?^k?R((u)f%J(9Ojq zZ;{}3zqZzo$?p@UUwq-qWl&GMC^E|)l5OkKd(a)dt2<^_cF3-5pIs4{E$USEva&9z zPDJOeatUn+$H3GI0=$YMaf)dp*DYRQeX+o$h5frVF4?^b3wu8dn-n(P7i@cc!t{$T ze7OwH6r&LGLVH(q?Niga&me>*{tU^f49XF8sd( zDhXtm6=B-gntnqFQeO)3b+J{hw*WtJs%xW5pLpE0^|0-cC)g-#I_;5W@Z}P5374Tc zRh{})wLUHd$1v;5C2oN`LKrI&u=QaF_wkvA{WeiU{!)$883dH zN?f|FOMk5{F<)Ygg}jb^Dm&*?lld~FSB0xvZ_>>l{kRTTkFzUH+BSO z+sMFmkqgEp8DQ}z5}Vy$vR>PW+w;Lyr6p+NIoN%q+uo7c|Dh{MA30pQfDgLA49vDt z*u7?8Pd9=x%~&Zea61Yn!>@(pXYoM_0f;{vp@#jKo{J)z; VnyeHX{E7eo002ovPDHLkV1nG_O3nZP literal 0 HcmV?d00001 diff --git a/doc/docs/.vuepress/styles/index.styl b/doc/docs/.vuepress/styles/index.styl new file mode 100644 index 00000000..2ae576ab --- /dev/null +++ b/doc/docs/.vuepress/styles/index.styl @@ -0,0 +1,23 @@ +// placeholder for test, dont't remove it. + +//.content { +// font-size 30px; +//} + +pre.vue-container + border-left-width: .5rem; + border-left-style: solid; + border-color: #42b983; + border-radius: 0px; + & > code + font-size: 14px !important; + & > p + margin: -5px 0 -20px 0; + code + background-color: #42b983 !important; + padding: 3px 5px; + border-radius: 3px; + color #000 + em + color #808080 + font-weight light \ No newline at end of file diff --git a/doc/docs/README.md b/doc/docs/README.md new file mode 100644 index 00000000..12221dd6 --- /dev/null +++ b/doc/docs/README.md @@ -0,0 +1,25 @@ +--- +home: true +heroImage: /logo.png +actionText: 快速开始 → +actionLink: /guide/ +footer: Apache 2.0 Licensed | Copyright © 2021 Anji-Plus Report All Rights Reserved +--- + +
+
+ +
+
+

技术先进

+

使用最流行的技术SpringBoot、SpringCloud、Vue、Element。

+
+
+

丰富组件

+

是一个包含前后端代码实现，同时提供底盘和丰富功能组件的开发平台.

+
+
+

功能完善

+

支持多数据源，多数据集，丰富的UI组件实现拖拽生成大屏

+
+
diff --git a/doc/docs/guide/README.md b/doc/docs/guide/README.md new file mode 100644 index 00000000..1520bf70 --- /dev/null +++ b/doc/docs/guide/README.md @@ -0,0 +1,25 @@ +# 介绍 +--- + +**大屏设计** + +大屏设计（Report）是一个JavaEE微服务架构平台，采用经典组合（SpringBoot，SpringCloud，Vue，ElementUI）。目前提供两种架构，单体架构和微服务架构。 +内置的基础功能包括数据源，数据集，报表管理 + +**功能架构** +- 前端 + + +- 后端 + + +**在线体验** +- 访问地址 + +- 默认账号密码 + + +**联系我们** + + + diff --git a/doc/docs/guide/deploy.md b/doc/docs/guide/deploy.md new file mode 100644 index 00000000..65113a95 --- /dev/null +++ b/doc/docs/guide/deploy.md @@ -0,0 +1,44 @@ +# 系统运行 +微服务版本的系统运行,可以在本地开发环境下跑起来。 + +## 准备工作 +1. 环境准备 +- JDK >= 1.8 (推荐1.8版本) +- Mysql >= 5.7.0 (推荐5.7版本) +- Redis >= 3.0 +- Maven >= 3.0 +- Node >= 10 +- Nacos >= 1.1.0 + +2. 从gitee上拉取下载项目源码,并解压到工作目录; + + + +## 运行系统 +### 后端运行 + + +### 前端运行 + +2. 浏览器访问 + +3. 发布 +``` +# 构建生产环境 +npm run build:prod +``` + +4. 其他 +``` +# 预览发布环境效果 +npm run preview + +# 预览发布环境效果 + 静态资源分析 +npm run preview -- --report + +# 代码格式检查 +npm run lint + +# 代码格式检查并自动修复 +npm run lint -- --fix +``` diff --git a/doc/docs/guide/devdoc.md b/doc/docs/guide/devdoc.md new file mode 100644 index 00000000..a5b829eb --- /dev/null +++ b/doc/docs/guide/devdoc.md @@ -0,0 +1 @@ +# 开发手册 diff --git a/doc/docs/guide/directory-structure.md b/doc/docs/guide/directory-structure.md new file mode 100644 index 00000000..a06ddb1e --- /dev/null +++ b/doc/docs/guide/directory-structure.md @@ -0,0 +1,77 @@ +# 目录结构 + +VuePress 遵循 **“约定优于配置”** 的原则，推荐的目录结构如下： + +``` +. +├── docs +│   ├── .vuepress _(**可选的**)_ +│   │   ├── `components` _(**可选的**)_ +│   │   ├── `theme` _(**可选的**)_ +│   │   │ └── Layout.vue +│   │   ├── `public` _(**可选的**)_ +│   │   ├── `styles` _(**可选的**)_ +│   │   │   ├── index.styl +│   │   │   └── palette.styl +│   │   ├── `templates` _(**可选的, 谨慎配置**)_ +│   │   │   ├── dev.html +│   │   │   └── ssr.html +│   │   ├── `config.js` _(**可选的**)_ +│   │   └── `enhanceApp.js` _(**可选的**)_ +│   │  +│   ├── README.md +│   ├── guide +│   │   └── README.md +│   └── config.md +│  +└── package.json +``` + +::: warning 注意 +请留意目录名的大写。 +::: + +- `docs/.vuepress`: 用于存放全局的配置、组件、静态资源等。 +- `docs/.vuepress/components`: 该目录中的 Vue 组件将会被自动注册为全局组件。 +- `docs/.vuepress/theme`: 用于存放本地主题。 +- `docs/.vuepress/styles`: 用于存放样式相关的文件。 +- `docs/.vuepress/styles/index.styl`: 将会被自动应用的全局样式文件，会生成在最终的 CSS 文件结尾，具有比默认样式更高的优先级。 +- `docs/.vuepress/styles/palette.styl`: 用于重写默认颜色常量，或者设置新的 stylus 颜色常量。 +- `docs/.vuepress/public`: 静态资源目录。 +- `docs/.vuepress/templates`: 存储 HTML 模板文件。 +- `docs/.vuepress/templates/dev.html`: 用于开发环境的 HTML 模板文件。 +- `docs/.vuepress/templates/ssr.html`: 构建时基于 Vue SSR 的 HTML 模板文件。 +- `docs/.vuepress/config.js`: 配置文件的入口文件，也可以是 `YML` 或 `toml`。 +- `docs/.vuepress/enhanceApp.js`: 客户端应用的增强。 + +::: warning 注意 +当你想要去自定义 `templates/ssr.html` 或 `templates/dev.html` 时，最好基于 [默认的模板文件](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/client/index.dev.html) 来修改，否则可能会导致构建出错。 +::: + +**同时阅读:** + +- [配置](../config/README.md) +- [主题](../theme/README.md) +- [默认主题配置](../theme/default-theme-config.md) + +## 默认的页面路由 + +此处我们把 `docs` 目录作为 `targetDir` （参考 [命令行接口](../api/cli.md#基本用法)），下面所有的“文件的相对路径”都是相对于 `docs` 目录的。在项目根目录下的 `package.json` 中添加 `scripts` ： + +```json +{ + "scripts": { + "dev": "vuepress dev docs", + "build": "vuepress build docs" + } +} +``` + +对于上述的目录结构，默认页面路由地址如下： + +| 文件的相对路径 | 页面路由地址 | +|--------------------|----------------| +| `/README.md` | `/` | +| `/guide/README.md` | `/guide/` | +| `/config.md` | `/config.html` | + diff --git a/doc/docs/guide/productintro.md b/doc/docs/guide/productintro.md new file mode 100644 index 00000000..1476139c --- /dev/null +++ b/doc/docs/guide/productintro.md @@ -0,0 +1 @@ +# 项目介绍 diff --git a/doc/docs/guide/question.md b/doc/docs/guide/question.md new file mode 100644 index 00000000..70d67042 --- /dev/null +++ b/doc/docs/guide/question.md @@ -0,0 +1,4 @@ +# 常见问题 + +## 其他 + diff --git a/doc/docs/guide/quickly.md b/doc/docs/guide/quickly.md new file mode 100644 index 00000000..3a1c4b86 --- /dev/null +++ b/doc/docs/guide/quickly.md @@ -0,0 +1,34 @@ +# 快速了解 +--- +## 项目简介 +- 项目源代码地址: +- 在线提问: +- 在线文档: + +大屏设计（Report）是一个JavaEE微服务架构平台，采用经典组合（SpringBoot，SpringCloud，Vue，ElementUI）。目前提供两种架构，单体架构和微服务架构。 +内置的基础功能包括数据源，数据集，报表管理 + + +## 技术选型 + +**1.环境** +- JavaEE 8 +- Apache Maven 3 + +**2.主框架** +- Spring Boot 2.3.x +- Spring Cloud Hoxton.SR9 +- Spring Security 5.3.x + +**3.持久层** +- Apache MyBatis 3.5.x + +**4.视图层** +- Vue 2.6.10+ +- ElementUI 2.13.0+ + + +## 系统特性 +1. 最新最稳定的技术栈； +2. 支持多数据源配置 +3. 丰富的大屏组件。拖拽配置实现动态大屏 diff --git a/doc/package.json b/doc/package.json new file mode 100644 index 00000000..6dbc50b1 --- /dev/null +++ b/doc/package.json @@ -0,0 +1,18 @@ +{ + "name": "doc", + "version": "1.0.0", + "description": "AJ Report Doc", + "devDependencies": { + "vuepress": "^1.8.2" + }, + "keywords": [ + "AJ-Report", + "Report-Archiver" + ], + "author": "anji-plus report team", + "license": "Apache-2.0", + "scripts": { + "docs:dev": "vuepress dev docs", + "docs:build": "vuepress build docs" + } +}