From cf1e60c9c574943b8e6cbd71c27561d9884dfe6f Mon Sep 17 00:00:00 2001
From: GU Yiling <justice360@gmail.com>
Date: Tue, 12 Aug 2025 11:46:00 +0800
Subject: [PATCH] docs: add link to `setTheme`, simplify readme (#854)

* docs: add link to `setTheme`, simplify readme

* docs: add improved favicon

Co-authored-by: Yue JIN <40021217+kingyue737@users.noreply.github.com>
---
 README.md               |  10 +++++-----
 README.zh-Hans.md       |  10 +++++-----
 demo/index.html         |   3 ++-
 demo/public/favicon.ico | Bin 4286 -> 4286 bytes
 demo/public/favicon.svg |   1 +
 scripts/docs.ts         |   2 +-
 6 files changed, 14 insertions(+), 12 deletions(-)
 create mode 100644 demo/public/favicon.svg

diff --git a/README.md b/README.md
index 897424c..82ae31f 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ npm install echarts vue-echarts
 #### Example
 
 <details>
-<summary>Vue 3 <a href="https://stackblitz.com/edit/vue-echarts-8?file=src%2FApp.vue">Demo →</a></summary>
+<summary><a href="https://stackblitz.com/edit/vue-echarts-8?file=src%2FApp.vue">Demo →</a></summary>
 
 ```vue
 <template>
@@ -114,9 +114,9 @@ import "echarts";
 Drop `<script>` inside your HTML file and access the component via `window.VueECharts`.
 
 <details>
-<summary>Vue 3 <a href="https://stackblitz.com/edit/vue-echarts-8-global?file=index.html">Demo →</a></summary>
+<summary><a href="https://stackblitz.com/edit/vue-echarts-8-global?file=index.html">Demo →</a></summary>
 
-<!-- vue3Scripts:start -->
+<!-- scripts:start -->
 
 ```html
 <script src="https://cdn.jsdelivr.net/npm/echarts@6.0.0"></script>
@@ -124,7 +124,7 @@ Drop `<script>` inside your HTML file and access the component via `window.VueEC
 <script src="https://cdn.jsdelivr.net/npm/vue-echarts@8.0.0-beta.1"></script>
 ```
 
-<!-- vue3Scripts:end -->
+<!-- scripts:end -->
 
 ```js
 const app = Vue.createApp(...)
@@ -333,7 +333,7 @@ export default {
 > The following ECharts instance methods aren't exposed because their functionality is already provided by component [props](#props):
 >
 > - [`showLoading`](https://echarts.apache.org/en/api.html#echartsInstance.showLoading) / [`hideLoading`](https://echarts.apache.org/en/api.html#echartsInstance.hideLoading): use the `loading` and `loading-options` props instead.
-> - `setTheme`: use the `theme` prop instead.
+> - [`setTheme`](https://echarts.apache.org/en/api.html#echartsInstance.setTheme): use the `theme` prop instead.
 
 ### Slots
 
diff --git a/README.zh-Hans.md b/README.zh-Hans.md
index e664bf2..e7279aa 100644
--- a/README.zh-Hans.md
+++ b/README.zh-Hans.md
@@ -19,7 +19,7 @@ npm install echarts vue-echarts
 #### 示例
 
 <details>
-<summary>Vue 3 <a href="https://stackblitz.com/edit/vue-echarts-8?file=src%2FApp.vue">Demo →</a></summary>
+<summary><a href="https://stackblitz.com/edit/vue-echarts-8?file=src%2FApp.vue">Demo →</a></summary>
 
 ```vue
 <template>
@@ -114,9 +114,9 @@ import "echarts";
 用如下方式在 HTML 中插入 `<script>` 标签，并且通过 `window.VueECharts` 来访问组件接口：
 
 <details>
-<summary>Vue 3 <a href="https://stackblitz.com/edit/vue-echarts-8-global?file=index.html">Demo →</a></summary>
+<summary><a href="https://stackblitz.com/edit/vue-echarts-8-global?file=index.html">Demo →</a></summary>
 
-<!-- vue3Scripts:start -->
+<!-- scripts:start -->
 
 ```html
 <script src="https://cdn.jsdelivr.net/npm/echarts@6.0.0"></script>
@@ -124,7 +124,7 @@ import "echarts";
 <script src="https://cdn.jsdelivr.net/npm/vue-echarts@8.0.0-beta.1"></script>
 ```
 
-<!-- vue3Scripts:end -->
+<!-- scripts:end -->
 
 ```js
 const app = Vue.createApp(...)
@@ -333,7 +333,7 @@ export default {
 > 如下 ECharts 实例方法没有被暴露，因为它们的功能已经通过组件 [props](#props) 提供了：
 >
 > - [`showLoading`](https://echarts.apache.org/zh/api.html#echartsInstance.showLoading) / [`hideLoading`](https://echarts.apache.org/zh/api.html#echartsInstance.hideLoading)：请使用 `loading` 和 `loading-options` prop。
-> - `setTheme`：请使用 `theme` prop。
+> - [`setTheme`](https://echarts.apache.org/zh/api.html#echartsInstance.setTheme)：请使用 `theme` prop。
 
 ### 插槽（Slots）
 
diff --git a/demo/index.html b/demo/index.html
index 59a32f2..bfaae29 100644
--- a/demo/index.html
+++ b/demo/index.html
@@ -4,7 +4,8 @@
     <meta charset="utf-8" />
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width,initial-scale=1.0" />
-    <link rel="icon" href="/favicon.ico" />
+    <link rel="icon" href="/favicon.ico"/>
+    <link rel="icon" href="/favicon.svg" type="image/svg+xml"/>
     <link
       href="https://fonts.googleapis.com/css?family=Inter:300,500;display=swap"
       rel="stylesheet"
diff --git a/demo/public/favicon.ico b/demo/public/favicon.ico
index df36fcfb72584e00488330b560ebcf34a41c64c2..4c296619103547c6cda2e3f32cb6a53403e7e4e0 100644
GIT binary patch
literal 4286
zcmc&&+iw(A7$5%wpLizm#V7v+?0TuhyJ9dAjA)F;=!1&BNn&ZOU`x3aMJPcVnkd9n
z5L0?#dtDo{TYCYslx>l2FGAgxcFUI1%g)d5cV>?rX3tKyON^(PJu}~&^ZmZ_-KUoI
zfc$OTXz|zj@j=VlU|H6~atX;Ql8baT<lRG$IG01PEaWlL_6icIIC@6UqJE$h$9{Vo
zmBANL-c+nE-jl|6Tr(wWx#xZdc}&a>qVY;K4tKte^5&<o`+NYq8v`h9eC(c!G``~+
zu5FASlD$_7mSgVj6k207*x&Yw@GVl87c<whUeCS3t2H36^$ec5F8ql)AJ3EvXDzzk
zdosLJ=^`H)MyC7mZRjmI@1q6ddgUUoBcV4jGTrAZ!bEaVt)u?DJWS7AS0cQf%il&^
zOBsk^8gmN?P){XmU^})AU~kK__@?U(oVfS_YQrDmc=vla)bX0~Kk_j7DCs97JH;Oo
z_lRKIY2|CCGp^DczyDf%n|?`MCKo2LxUzud^dc6PQ<$C~!{B5H=Pp;Es&z}2&+6D|
zjU5Lu^%$RxX8hdjYdp)B&71M-AC)S$ZP<FNaZcOI7@fI{Q@x*|tmz5S1?^NM`r3g5
zZCkNlWMgb{q(zSN605mw9>AWKrxE(|2X$5>pn*8QG^=C?imnc}zp8S=;A9uh$r(Ox
z*rf6Uu@krBpiXn)f6??LI)-bpl3p^Pm`PKqG4Z93aiD#x?EM}$l0&#PKY=?-Nz_F?
z6<usnn9QjW$(QBL#YTUpOsD&HiEVG2fpSoLMt@QM$GAA$xgE3OCsV0WoViq<!D5~)
z{x_eSe3dlj^|fNwB*Mt80aOHEkTX4wvzPXW-R__%T8$FXyY^@DuOBGGQK=gyeEQ4j
z-d$K)xod*(rEw2^k9LpV>_Go`gX7<V>Bc8E&!}nMxhH<c7su~q-&ljn1^ZfGQn90R
zu^U6zP&ZBA?`?SoanWO;<F8~)a=^<f_DWsn*8Dl^`t7Fip7vnvx;ZyoD7?yX)t%dN
z#+AmeRDP0O%d6V9;Ktlg;rNozt2_MhssCL5$9#7!5h)m-`Hi+W`L@<EvFrOwMMtZC
zscpf1%sYjSNc?A%N&IPk-kJOve-ZI<Q~qJ@sp)=4YRup37J+%LHvEyl?KAm@`IkA$
zqyx&|7CW)79*(u?;>b^6-u9kZKl5zN`OLq5^@lq8>cVsQUGix@{j6=<D&JJGXOz7f
z&pQ*J{VB0I#%FTZU-GHA@I2awzRT(x+=fXl&Y=7HsZ8DX!**hOJX3$kgS`Ojq*u<>
z=YaC1n(lX1JsVDhrKZKe9K#stx>hHB(ECc~COfY3apIi)i@X1z4D5;68!_*D*Xw8M
zjrw40GPmuMi}$4QonDt~R{fXsc<l8|gE7k<F&|zE)5peM8OYPG|J3rZ-u@^3xAb1u
zr+YPw@67KH_QE_vKKAsURX^*!?1gl{=L_t5dB5LZv^C=}c=ecX+_)gKZW;58P4=hG
z_h+%v2W_v<sAtCqoxX}|8=?onzB-@0kp=7_kca#G`)DZp`&-qL%=fpG*Yf-R*8d0i
Hzvh1cJ!Pn5

literal 4286
zcmds*O-Phc6o&64GDVCEQHxsW(p4>LW*W<827=Unuo8sGpRux(DN@jWP-e29Wl%wj
zY84_aq9}^Am9-cWTD5GGEo#+5Fi2wX_P*bo+xO!)p*7B;iKlbFd(U~_d(U?#hLj56
zPhFkj-|A6~Qk#@g^#D^U0XT1cu=c-vu1+SElX9NR;kzAUV(q0|dl0|%h|dI$%VICy
zJnu2^L*Te9JrJMGh%-P79CL0}dq92RGU6gI{v2~|)p}sG5x0U*z<8U;Ij*hB9z?ei
z@g6Xq-pDoPl=MANPiR7%172VA%r)kev<ISBgE$F{SFy+(=9Z)f)De0Se}ZDZW}Z3B
zElCeVrw;K0Fdl_Cg=gZOFXXc3pL)Q05CAuT+XucQ<8g~3dteP~|7s7c6QYP;fy;mF
zMN;>tV-_5H*QJKFmd;8yA$98zCxBZYXTNZ#QFk2(TX0;Y2dt&WitL#$96|gJY=3xX
zpCoi|YNzgO3R`f@IiEeSmKrPSf#h#Qd<$%Ej^RIeeYfsxhPMOG`S`Pz8q``=511zm
zAm)MX5AV^5xIWPyEu7u>qYs?pn$I4nL9J!=K=SGlKLXpE<5x+2cDTXq?brj?n6sp=
zphe9;_JHf40^9~}9i08r{XM$7HB!`{Ys~TK0kx<}ZQng`UPvH*11|q7&l9?@FQz;8
zx!=3<4seY*%=OlbCbcae?<QnEgvj4i?s}Yk=qA2z`-^*<eK3c)MS4JOdbsTQEOa0)
z0NWqlna2rzs>5^V_}*K>Uo6ZWV8mTyE^B=DKy7-sdLYkR5Z?paTgK-zyIkKjIcpyO
z{+uIt&YSa_$QnN_@t~L014dyK(fOOo+W*MIxbA6Ndgr=Y!f#Tokqv}n<7-9qfHkc3
z=>a|HWqcX8fzQCT=dqVbogRq!-S>H%yA{1w#2Pn;=e>JiEj7Hl;zdt-2f+j2%DeVD
zsW0Ab)ZK@0cIW%W7<X*Er!BfRbvU93$DH%#v6dRt^6HBxz1xBNHx=$&_Gv<&J}Ljk
zJN<Fzx(`Oe@KgQ0F$<14=XV#WK`o#6Ku>z}H{&~yGhn~D;aiP4=;m-HCo`BEI+Kd6
z={Xwx{T<?%b6i9IjI)Ls)S{-*mq<@~R{?$}ZKjf;^k75i_}(2MXt}^SEBVg7AI@28
zo_uPg2V)_e-`2Ois=PYoe%9u*n9({PFR)OnHJPi{dNx>Kx<YG`4QQ>D#iCLfl2<BD
h7L=-;Q>vQGDitKtN>z|-AdCN|$jTFDg0m3O`WLD4_s#$S

diff --git a/demo/public/favicon.svg b/demo/public/favicon.svg
new file mode 100644
index 0000000..dd4cda3
--- /dev/null
+++ b/demo/public/favicon.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none"><g clip-path="url(#a)"><path fill="#42B883" d="M12 0a12 12 0 1 0 0 24 12 12 0 0 0 0-24Zm-.792 5.307c2.192-.025 4.366 1.134 5.43 3.304.909 1.852.878 3.61-.098 5.645-.477.995-.487 1.06-.241 1.578.214.452.727.779 1.221.779.454 0 1.15-.586 1.252-1.054.1-.454-.193-1.118-.607-1.377a10.147 10.147 0 0 1-.393-.255c-.129-.1.42-.38.741-.38.687 0 1.247.526 1.375 1.29.055.333.134.422.44.502.859.222 1.297 1.451.755 2.116-.22.27-.23.271-.305.042-.267-.801-.666-1.12-1.403-1.12-.319 0-.572.128-1.098.556-1.006.82-1.866 1.303-2.907 1.632-1.276.384-2.752.478-4.086.156-2.162-.431-4.232-2.11-5.252-4.257C4.758 11.782 5.135 9 7.033 7.077a5.924 5.924 0 0 1 4.175-1.77Z"/></g><defs><clipPath id="a"><path fill="#fff" d="M0 0h24v24H0z"/></clipPath></defs></svg>
\ No newline at end of file
diff --git a/scripts/docs.ts b/scripts/docs.ts
index 5e6dee9..40f3d73 100644
--- a/scripts/docs.ts
+++ b/scripts/docs.ts
@@ -42,7 +42,7 @@ README_FILES.forEach((file) => {
   writeFileSync(
     file,
     commentMark(content, {
-      vue3Scripts: getCodeBlock(getScripts()),
+      scripts: getCodeBlock(getScripts()),
     }),
     "utf8",
   );