From 384faccc5df69e8ff95870aa643f4780b1887977 Mon Sep 17 00:00:00 2001 From: devin Date: Thu, 31 Jul 2025 14:11:03 +0800 Subject: [PATCH] =?UTF-8?q?doc=EF=BC=9A=E6=9B=B4=E6=96=B0ReadMe?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/docs/ReleaesNote.scripts.md | 6 ++ packages/docs/public/opendesign-logo-dark.png | Bin 0 -> 4067 bytes .../docs/public/opendesign-logo-light.png | Bin 0 -> 6116 bytes packages/opendesign/README.md | 57 +++++++++++++++++- packages/scripts/README.md | 40 ++++++++++-- 5 files changed, 96 insertions(+), 7 deletions(-) create mode 100644 packages/docs/public/opendesign-logo-dark.png create mode 100644 packages/docs/public/opendesign-logo-light.png diff --git a/packages/docs/ReleaesNote.scripts.md b/packages/docs/ReleaesNote.scripts.md index 27c9f58e..84f0a915 100644 --- a/packages/docs/ReleaesNote.scripts.md +++ b/packages/docs/ReleaesNote.scripts.md @@ -1,5 +1,11 @@ # [open-scripts] +# 1.0.0 + +- fix + +1. 统一gen-icon在不同系统下生成path的分隔符风格 + # 0.0.23 - fix diff --git a/packages/docs/public/opendesign-logo-dark.png b/packages/docs/public/opendesign-logo-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..9b90c7b1bfc792b20397106b0c720e1ae507c540 GIT binary patch literal 4067 zcmeH~XFJ@B7RCQ#n2FI#wCFjA-lEs&gwcB^dM8mv86^l3M2XHI7^6f)JL-rUooE?G zMDO7sgov9jaPJqmXT8{KJ^SVF*)R4=GJtE6!I)qG0FY^GsTlzPNcm58xC8z(t+TC} z{un68NK*x`%iDkTFMSu;$Hc}xk55Q^k(8YB@>ObD`s<9$tn4>Axq0~og~cVP(z5cm6_r)! zYD`USUH!X;_l+N#np;}i{%-H+?CQbxe(dWX7#te@G%`9iJ~25pJ@a{XZhm3$3vOu{ zzw&i;ZGB^NYkOyRZ~x%%==<@>Kc{EsKQ1nRUS0pX`JGPN69NDv`PyoaOhR#o1s=+@ znsh^M394$8M1;?}u-1laLd2+A^I3Kkf0qSx%FxIf(V#k6GSh1{!s+q$6?8AZD7Qvj zDA!6m(<^8%7$jU4_(EiPY`UbS#!f#(KV(wmqrdy!ZTuc$&UUV+dVOwRh5J6||IihF zMDh&x(u`2m)@ApGOx-XMVogo^%xIxa1y=3ed@ttYs?i=%GQ%4buUbA=;NOp;{)#Gf zV2o&nl-BT~HIOC?JQh+$<5IkFGYQ?immA;=QAIwl?)6UHLX7sg$wM7{4jK4uV@D6; zuXcf`)TQeP5>NluSChwcDO~t`CidpZD>CeY*cQ2OEnCnt;?rq^Oc8y%kOM=t`_$e;G|pd&An1V?ur^-Jq3I-quhROxj4B9PpjS z-Fe`^Rqpw;xMqXDKxe9I&TJtf4X^s?X6NO{1W4}HfQEt(ZWT1>d*Qy1uRnk1Qe#zN zR9zwkC65ftm;)zM|1rYXgMvJ^WEcx;LK9ww$O9UNDaKf)*(b7?5U{G>-^m>}M&TQh zM{$3^ZjiJF57B?$JtP&hfgnzG$bC|RtglbL|JZZpkpiK{;V+!V)xkqT%xhL1)=9t? z@k(R6J3q2&igPETI@!-Y)|VMgyI4}!lbf;pr02Nbx(Uqspzs5N8T81T|4n}`K2H-+fm(&sWo$wSpL zXK^Mc1~qf8veq)%J)3d*u&7L;Ha0c$6i-ZYmQDN(dD1KUeDfLy(0Yx1qPB8({$jak%R#XzIqChAaDh-8G6(~=p|Q)`EH>$N zqH`vox~5AHK(BRJi`VEuv|L2XFYjj$)A~@N0vkl58^56|%g27m13n8%+l9t?`t`>F z7$ipt&*QQ(%ui}S$@h@?6_^9haJJ0a;4-(~B4 zgrX3&f~@vVKZUP8ub`AGS8RR=F<@2gDdSEKsJfWp4^U^9%abc~Mf0Arx;k$z7sR+e zwzwlP@b{O(qvy#Wh}ez3b$*E|{U-z;=-863UCx}i!*b3ch(OobZf2d~b3wXrb?&6J zfBi?(6cD(jn@gTIS^Lv=RV(>$l z!B$%PXI9rh<;chyUs}sYwT1Nhc3;|212-=6QpsgP5AP^{ zX>uwIpmK~wq&3%*p}Zy2ecfnLPD(hUIOlH(Dw%GJL{BXk1vWlX3>B3hg2#TL{$Xgc92s^h+vt{b@taxWb;2_;uRbv?KXnLkj5SnxHLh4$jk?Z(o zKUziFAg?qMYZ$|o^BCL|-_)4n0iD~n zj5I*xD&TGE18%UPE`R*BT3bP0SP*L?qEIGNGPEyrN>L8EA!lXJBTV5g44NWpv7#@s zgR;9YqYf3bBE(n{vQJG8Tv;04v8+b9FFd%qZkyffX-fs_rl~TMDcH*rxN+B=NrHN1 zoCkx8MUHr(?Yoe)7AMG((Rz2c^?Xn>}#V5o3=9(0vY$gciHG=6dXr_C|?H1Iy)B|;q^La|$t#y}Lcn%2yUKY6YwtqvHxr^MvCutv{zG58i7iScKS`jkeBWfnO&U=1^jgtc}x0*3x)W^Cn#=8;pMmZ7vs3a5Q< z#)n-B7?twAtx4U9G7V^^_ft^=8gGLw!T50cDf{V6lRVc3#!C9?r3K5A$BCx`>G4C^ zy+)N(J=!ueY&wQvCp<~fo&`l);0IneIUSVk3KIF(NojpMU2J7YGb_^L9fOrS#+^vr zk=F@sTsu1BVgYw3R96=smozX(^{Pc10Q$k-LE%&`kC8OXTrQ@q3oqer#J zHgrJkgs}3+q$10{v+$*aMy*07*!8UzVZ(QtLf3Ll&vt`=ragFd+<@RBfGqk*B5qwbNdbF?y>gQ?}!1f&*tdm6b zM2g&1EI#D)x|mFC;QEP(Ml%EQE}wC|y}c`|yVm^SP>r@1WfJfY6B&0GX$M(6c9f_R zmTDQK!whXyIL(aY?bPP$^fsEfg=D=MtUZQhWxWooetqq5c6f5YWFiKV_kzXJAGJN9 zzGn2eqQ4Ai{;A6`7XEfZnly>uNE4wJ{w+Z+4o z0{j@ZF5bTW{mqR_H{I?$LU$osr}A4x0K{sA62L2vVoEP9&;DT^-YdFrcGN`HuOwn= z6{~khye)B*s!L-Dz#^e%cwI)7r>kbe2s2cs%C@Fk^z*Stek&oWTy4={FWjl9_$KB9 z)xI^U0S%r(qNfW;p~q22KO;m7ArZenchiae_g}bdtLzq>%6m#yKwoV6r>g+k>TtDs I6^GdW0J$pz@&Et; literal 0 HcmV?d00001 diff --git a/packages/docs/public/opendesign-logo-light.png b/packages/docs/public/opendesign-logo-light.png new file mode 100644 index 0000000000000000000000000000000000000000..24633e626b911f5d9c172674a5783d18ecb9a2ec GIT binary patch literal 6116 zcmcJTOhEj?vBN4v`j+ z6n;MX{RiJC_kGVj=e{4@_c`~$3-e4@os5`)7ytl}X=oNH$__ghF59eea6cSmPfSF#(loX1-3b*y&l7I%kY;7locah9?7kh|lfI<0t`QIEN z&?U=lqW$`-bneXz8h;AaMnVlwCg+HqaU05i7AQ);5ai-v!<91gLU5hp8(Xp~eDScD z#xEcR3J*u7dqGp9MrJZ5l%kaG@CzX)xsGzwq6A?4QO#AltC&1ori%FvHj97MX0*}} z8r_HgVeRy7hhb~9beEj7P#o+eb8r;bD6g&h5uetIg3613C+^3lAc97;F(Dv5(Dcc1 zK-A{58rSJFnn~F54Ja3B>@VmObrUfc1Z!ETxKpSYC#BT~r;w_dy&UT^t^3$pf0>MK zmN?E>%$95<7Qketo|d>G5+3JEt&vjH2i=Og=d?>$^n5ckXt2XinV0x3d2C@!E32^8 z65IalyWlY?bj|p@(Iz$wYSpl?lt1UsNap>OGVfGp3?SV?XQ@aMX@YxWb;R_9O^=I- zl=$M?_Xr=ioH4}o=x6a)UC>oX{j4172^3r^=0+$c_g(TbC>r4zTLrCCamGEo!yc;K z!;8kDu_=Hn^RXF*rI`V9otyG^ZPr`1CSeRA$~%Rf3jM}wVMH2b(mkV`L#9Ge_ZiZz zmB!&L+qGDOOxF`5#q`&u?%>JWh^USI(YFXQB|({A+miQkt^t_IDHwenV@%hR4;7p9KF6Xh@X=+sYu;IF@HrP z)@FF0S7yuPP+}B#yX7ky8wtSS0cWHUW=n(w^8Qmx-MGe7b9hoy{W02}eF?~&1DeZc zV-C;O>`LV=OV1|T^nHjWf0q`{pun6}n*Vygbxhy5soP02><~7BU*j*Fyev=`q7!B% zR)r_i5hj&jL@<*7!2k??;Ai<99eT+y+B4RtyA0R1{YhQWStrxwl&$<$2{yV>y^9q{ zu6gC}Ju#rH0PcKc<8Gd#wnu_+W4a%-X|{UZEGPDMxL_iT|E!LQJ?D_Qdk>i4%kM*2 zRrFy>oah-#M~SO^6)Xgkr}1>^+`gHl*i}?^a z6ZZ}I5)o^AC$-JM02$3alSWVgw)V~=q=qQRAY1v zpnl)!0D@%$@VF_>wuxV$???RC{nn`9{m*ThD~)S4+`WB8cInY$F!R1(@xpfnLwU%bF0V!*FULUS5N>`D1VergSAEojeRn?eD%psttzk=Y~0xt2v^fcUJ z-|D`_YI$C1LVmI16a$Eh1Mpj%=R2n!syqDseZ7`SCEO>`12(3rMv2)c(%v3SwECJr zK0ZaZe#$^<-Vi5S6@+;ELQ@J=1XYAK?6zMBCpX=~Q1!Uk%E$4|9uHUtQ3_r2>w|te z2a6CP(C;^NzaL`*li$Hdk=pqE4GtzmSgGV(Vrv~aEH9$UDR#tkb)qw)=GN-ViaQyW zDw!Vs@}nlw5-gE2xXfB9C%c}V_Y^rzs=fAGUFpXCfI} zB?V&mVDlAU{2`up26{pX)*AhD22>feZ7YuG>*fC5&rjlnoA*eT339_KvU=BO+@ZBS zJl%k|9HmFr^u|Ye0!@r?u=@1T!h>TS55X6S2 z9u$)dy_L|J7`@jRxw4?UXh;(JWDTBUZ8Z_V1wuEeG?}TpcbbC3T9{XmE!@2~`y-s~ zUTap>%9}kjH8Zez;P(FMgCFAi?M*-VzE?T26ivJ75!L(Si8o6}G*PZ*1W-j8OOPmw z;@wgz2r!Ocok<(S0Oa5?e79Dwk=Z%oKptKt%Z%Meu%tA(EN$!O=r6&om5wlCSPK zVD#_g%MM3%WQuINf32Gp4=~YRJ7bJtkWdl1@g)tQK6E8sC3x|ZX|(*Hn(vUZb$%)R zq3O|M#w4l3p@>`gQJ?)pO^9b%&&4hp2;5F3^e4f-iQ6$yhr$O4;uUGAff8K=8k66C zVIMUbai;|a|C@8t53PkYw5z(mGkc_pyuqjU*t5%pA0UVqQ1Iq5 z7jEKuJ(J3;fu2DFGEmxDt~**MONWGW4xa99;N6)uFl5_9b~_WVPl8itVY;$W|CQSM zac`Nhjl|K6TGYn#zSD1p44Bc^Aq4shg2C8aR4@*GHJ z6Uj>UJU9%~va2WgpMYZg=X`9Sq0P{C*E@y&CRelQ?61nuyt3)9Ihe;dhA*!v3c7>Z zIi=JBb&GC^oNpE)C9)X3bhg&^w6x>bz7SmOzGl^u*OrB9X`}hw?}kL2@1=z)hU)qE zIGI8FEZc?q48p6wS2|nv1)9=@>8Mv}Q$jtnqe&E;d=gJ{AVMS{H~eCW+n!bKJEZQa zeZ=M^o?WLYkPQ?(q#D@OmEtoFn`sk;JY%U1#J$X$=9uSE=Dlm@@SY5q^^`h1>JK%f z4rEIT&>bA3y~|rkiSJ;^f4>uP$O=GAmT8f!ejP{$sAJG&%hC_r|4LGaB!0^T2#THr z-D-Frx~d{)sNw4f+sdDHC(Y!-{T>1?sUdMl0Ocg9#&x{zI6%5a#U);W(shthTXm4) zG6!AvxYWL)R?aj5|M)E#sP2Lkmc zriV;>JDqXU>5&GqMHG^ZljcQT%4?;(Pa)n2jKBpF?%t4m{M^kp@`QM|E~`~|M}RHN zmVwUc_`rh_MIjpQ5iuNoT>HS@Mw&gc>)z-jqEaU{@A$18*R7qCnKrVqvv9n!Ys0rIQ0rs3 zN=+kcu&B#h&!M|FHz6fEAq1|GN5-`(a=uK!O3_l_hyVb1*WyeBZRn1F%(PQJP`Tsx zNkNO&>4jE)#A6e&t<#^!5B(i3-93k5G$&1lcY|`Py!Y;~SIRSwuHz6%Cg~m07b>jh zjeMW~`~o>6CpkjasA?|w_xE0rK%jjWc>O1Fin<8U6r19x_eLP{u)XQoZx`Uqr7LeR zPb^!BO#dU78w+PlV_%G9HEbj(#VCsKA>mV(7(Wn@Tr9KQnpni8$06dwsjva;{k=R% zz;o@`0(M0fbwzR{qjswOt7+@RIvK>eRCdK#MamWn)5FjNrKt;fH+5<*O&fNpn9{#} zr1O^b_yD0-cODUULLqpk#P@uOPgYjtAH6!bDCs!QU->Gg2kH*GWk}r#&rt)Hs3Q}z z){1p~1)1@)Ecu=NV%%v5C(D#v;|ik_kq*{v8B&Ut%kX`DVoKRO(sZRUD{ZRqOr#Q4ahgzqXkg$1 z`UHfDRM@E6_6EAXhuLP4)Y-`a8W8SKbNo>$+5*SO`Z7Qg8+9(IpS;{_Hl|HemH zk7D%J&onqvn#T1T>xQxz9DCOA41?b!N_G%7@KMr#6@j75!+B9->8C~`Vd?52gRgZf zyu=&Qhr*GXjOi_ZW3Au5&`jLGO|}z8JN|s~L=pKJ@_XWYFZaK@t$!z=Kz&iBmRlo& zzVRVp*B@LERA;slg_^VZ#Bk;pI~@jWzg2qq^TVoas@d^aC9GUMW=09RWy*6E)rfr< zobXcj!8=O08t7iL_lme$29@Rs>b7}6uCA+O$*SO-&J%ZL58KKc#_aY#RwAJ8L zcs&Q7xb&RHnf9_}k?N3&oaiGTm8x$@fS1*ej`+AY@bN!Fmv<|>6JUrECREWmB) z11wA}&gYG#*@qJSqcs-gPr&c40uZ7b$|YXoqxrRW=MIl~e~CT7y{u4d=Wu@}B%WMx zS#U}E=mvi5Rf<2H``?;U)DvytC=Nc>s>b@asKnL#9aNEP^`%fq=c=rk#eL6Ii^1IE zr7G2hD=Ij3@!@}@zdxzArKXsU0!%ET+XwSm%b>b}qTy02yc38nfw? z+aVdJOFn0(vSI4w`Opn^4tGb2v=!^va`kV{)4u|dQrw3&*Pp7*QPS~kww#`BW%TSzgVeZ+;j(o+lE@IkIaag)c-ozrVuyz^CC zuh!lnW9;!piq?HywMdb5qKO+Vus3qK;Wa*Ax4}qAL%i{GBYiGn`Gv)02JnTY17WIR%y#d>q&P=; z|4y{`MWoti{LB371c@rY;>1WwiCmvKrfyWUCU!1dT{LH526nxw7c zc?zdn)eN-Es}8N5GGqFsf^ERy5PnO(q=*7SBCb#&l7?Qs)%Zg}u?<|*OsFZ;BJOx@ zfSm=s(OUbbk}8)&B)f`}Km54*MZA_h$IpALO#t82F3HM~&9(@|7-J5c>Fj&t{nY~L zio$Qhqhw?ebnw7q{?*g`5w<<=C@cTKAvG>HOi} z8}&#BkZ{P(r)%(2<*sbhCDzC|Yi(TgMQ%RKG{-nqA{6sEO(Shv*&)Bv5Kuc~Ch8Eo zC%dKLLPLv_u1~_|>#L8fw~vq2K5b~79EWIF8eIDc*!*^Ip)t#I$=rPG#W?Kd;VX)* z;;_eIj-xB_S%YfC^*>nA0B26rSh9jiux0fj5qR9=FW?;w2d#XPh65h~d-N=>zF=Uz zQKWG}Ys~Y(qW=W7;zi-@Bzi4tp8s%Ry(GT&N?Xa()mqJ|!8D!G$zKHCvgER?E!^=nN9~-;E2e(>KE|9eS*Dx+kB2O?mz;+~RnstZv z*aZ#X2d7oJfIzaWv2YsQUmw-mNkcPYe9ZTr3K5=h+nqb*3f&AtJXG)GY#9b;ux%ib zO)#^CX}_?D6rJ~<0!4p9)f2q0+2n)vQNLK;2ejA?C?R!Jf;xHPQ)N`?$PP5w zte)9ujmv23M31NmN!it!uG%^Z80~`thW!6lg9VPs4{v}~VLT_%ucKagx;>hbqlBaK zDB^=H%*w}pEm3@j(%jn&f2z>d-%o=iD@rXBLF+or#4395SrtL~$6$0*s;NzZBpL6& zwXt_Z(9}W-%nIG1TTD}QX0~3a!v7Xq|349LesITJ>u#r

+

opendesign

+

一个 Vue 3 组件库

+

皮肤可定制,使用 TypeScript

-- vue3 components for opendesign + +## 特性 + + +### 皮肤可定制 + +提供组件变量体系,可以快速定义一套新皮肤 + +### 使用 TypeScript + +opendesign 全量使用 TypeScript 编写,和你的 TypeScript 项目无缝衔接。 + + +## 安装 + +### npm + +使用 npm/pnpm 安装。 + +```bash +# npm +npm i @opensig/opendesign + +#pnpm +pnpm add @opensig/opendesign + +``` + + +## 使用 + +### 引入样式文件 +``` +import '@opensig/opendesign/es/index.scss' +``` + +### 使用组件 +``` + + +``` + + +## 许可 + +opendesign 使用 [MIT license](https://opensource.org/licenses/MIT) 许可证书。 \ No newline at end of file diff --git a/packages/scripts/README.md b/packages/scripts/README.md index f1d3cba1..dee5c4ed 100644 --- a/packages/scripts/README.md +++ b/packages/scripts/README.md @@ -1,9 +1,39 @@ -# scripts for open-design +

open-scripts

+

用于构件opendesign组件库、图标库

-# 1.0.0 +## 特性 -- 【fix】统一gen-icon在不同系统下生成path的分隔符风格 -# 0.0.20 +### 组件构建 -- 【fix】修复图标路径兼容性、文件名转变量名兼容性、不同实例同 id 的相互影响 +支持构建vue组件库,编译样式文件 + +### 图标构建 + +支持将svg文件构建为vue组件 + + +### token构建 + +支持基于配置文件生成token文件 + + +## 安装 + +### npm + +使用 npm/pnpm 安装。 + +```bash +# npm +npm i @opensig/open-scripts + +#pnpm +pnpm add @opensig/open-scripts + +``` + + +## 许可 + +opendesign 使用 [MIT license](https://opensource.org/licenses/MIT) 许可证书。 \ No newline at end of file -- Gitee