This is an automated email from the ASF dual-hosted git repository.
sushuang pushed a commit to branch enhance-examples
in repository https://gitbox.apache.org/repos/asf/echarts-examples.git
commit 3d39db96c138dfa1905bfa68c979a232f0d3711c
Author: 100pah <sushuang0...@gmail.com>
AuthorDate: Thu Aug 7 19:08:37 2025 +0800
Exclude some bmap case to avoid thumbnail generation. And tweak README
guide.
---
README.md | 29 ++++++--
package.json | 1 +
public/examples/ts/heatmap-bmap.js | 1 +
public/examples/ts/lines-bmap-bus.ts | 1 +
public/examples/ts/lines-bmap-effect.ts | 1 +
public/examples/ts/lines-bmap.ts | 1 +
src/data/chart-list-data.js | 114 +++++++++++++++++---------------
7 files changed, 88 insertions(+), 60 deletions(-)
diff --git a/README.md b/README.md
index 19a267df..b0655e7e 100644
--- a/README.md
+++ b/README.md
@@ -261,20 +261,39 @@ node e2e/main.js --skip npm --tests bar3D*
## Release
-1. Update example snapshots
+1. Update example exporation page and snapshots
+If any metadata is added/deleted/changed, we need to call the command below to
sync that change to `echarts-examples/src/data/chart-list-data.js` and
`echarts-examples/src/data/chart-list-data-gl.js`
```shell
-npm run build:example
+npm run build:examplelist
+```
+Then, commit the results to git.
+
+**[[ CAVEAT ]]** DO NOT edit `echarts-examples/src/data/chart-list-data.js`
and `echarts-examples/src/data/chart-list-data-gl.js` manually.
-# Node: If only build for default theme:
+If any thumbnail in [example exporation
page](https://echarts.apache.org/examples/en/index.html) needs to be updated,
we need to call:
+```shell
+# This process is time consuming.
+npm run build:example > result.log 2>&1
+# Note: it also calls build:examplelist internally.
+# Note: if encoutering problems, make sure your local installed puppeteer is
in correct # verion, and there is no local puppeteer installed in folder
`echarts-examples/tool`.
+
+# Note: If only build for default theme:
node tool/build-example.js -t default
+# Note: If do not update echarts-gl thumbnails:
+npm run build:example:nogl
+# Note: only build one specific example:
+node tool/build-example.js --pattern my-example-basename
+node tool/build-example.js --pattern my-gl-example-basename --gl
+node tool/build-example.js --pattern doc-example/my-example-basename
```
+Then, commit the results to git. You may only commit the thumbnail changes
caused by your recent modification and leave the rest unchanged, since the
process above likely generates a large number of thumbnail changes, most of
which are visually indistinguishable.
-2. Build and copy all the build resources to `echarts-website`
-
+Note: Build and copy all the build resources to `echarts-website` can be
performed by:
```shell
npm run release
# Note: the config of the dir of echarts-website is in
# `echarts-examples/config/**`
```
+But, currently, **we do not need to run it manually**. Instead, just call
[this
workflow](https://github.com/apache/echarts-website/actions/workflows/deploy.yml)
diff --git a/package.json b/package.json
index 3c1b6985..45e96242 100644
--- a/package.json
+++ b/package.json
@@ -11,6 +11,7 @@
"dev": "concurrently --kill-others \"npm:watch\" \"npm:server\"",
"build:example": "npm run compile:example && node tool/build-example.js &&
node tool/build-example.js --gl",
"build:examplelist": "npm run compile:example && node
tool/build-example.js --no-thumb && node tool/build-example.js --no-thumb --gl",
+ "build:example:nogl": "npm run compile:example && node
tool/build-example.js",
"compile:example": "node tool/compile-example.js",
"test:e2e": "node e2e/main.js --bundler webpack -m",
"test:e2e:local": "node e2e/main.js --bundler webpack -m --local",
diff --git a/public/examples/ts/heatmap-bmap.js
b/public/examples/ts/heatmap-bmap.js
index 66c483cc..2624d3b8 100644
--- a/public/examples/ts/heatmap-bmap.js
+++ b/public/examples/ts/heatmap-bmap.js
@@ -2,6 +2,7 @@
title: Heatmap on Baidu Map Extension
category: heatmap
tags: bmap
+noExplore: true
titleCN: 热力图与百度地图扩展
difficulty: 3
*/
diff --git a/public/examples/ts/lines-bmap-bus.ts
b/public/examples/ts/lines-bmap-bus.ts
index 06191806..39ece9e6 100644
--- a/public/examples/ts/lines-bmap-bus.ts
+++ b/public/examples/ts/lines-bmap-bus.ts
@@ -1,6 +1,7 @@
/*
title: Bus Lines of Beijing - Baidu Map
category: 'map, lines'
+noExplore: true
tags: bmap
titleCN: 北京公交路线 - 百度地图
*/
diff --git a/public/examples/ts/lines-bmap-effect.ts
b/public/examples/ts/lines-bmap-effect.ts
index dab4fe99..a5ce4c46 100644
--- a/public/examples/ts/lines-bmap-effect.ts
+++ b/public/examples/ts/lines-bmap-effect.ts
@@ -1,6 +1,7 @@
/*
title: Bus Lines of Beijing - Line Effect
category: 'map, lines'
+noExplore: true
tags: bmap
titleCN: 北京公交路线 - 线特效
shotDelay: 2000
diff --git a/public/examples/ts/lines-bmap.ts b/public/examples/ts/lines-bmap.ts
index 9443311a..ed520eca 100644
--- a/public/examples/ts/lines-bmap.ts
+++ b/public/examples/ts/lines-bmap.ts
@@ -2,6 +2,7 @@
title: A Hiking Trail in Hangzhou - Baidu Map
category: 'map, lines'
tags: bmap
+noExplore: true
titleCN: 杭州热门步行路线 - 百度地图
*/
diff --git a/src/data/chart-list-data.js b/src/data/chart-list-data.js
index abd405b7..11c0bf9f 100644
--- a/src/data/chart-list-data.js
+++ b/src/data/chart-list-data.js
@@ -1113,19 +1113,6 @@ export default [
"titleCN": "关系图自动隐藏重叠标签",
"difficulty": 3
},
- {
- "category": [
- "heatmap"
- ],
- "id": "heatmap-bmap",
- "ts": false,
- "tags": [
- "bmap"
- ],
- "title": "Heatmap on Baidu Map Extension",
- "titleCN": "热力图与百度地图扩展",
- "difficulty": 3
- },
{
"category": [
"line"
@@ -2635,48 +2622,6 @@ export default [
"titleCN": "65k+ 飞机航线",
"difficulty": 10
},
- {
- "category": [
- "map",
- "lines"
- ],
- "id": "lines-bmap",
- "ts": true,
- "tags": [
- "bmap"
- ],
- "title": "A Hiking Trail in Hangzhou - Baidu Map",
- "titleCN": "杭州热门步行路线 - 百度地图",
- "difficulty": 10
- },
- {
- "category": [
- "map",
- "lines"
- ],
- "id": "lines-bmap-bus",
- "ts": true,
- "tags": [
- "bmap"
- ],
- "title": "Bus Lines of Beijing - Baidu Map",
- "titleCN": "北京公交路线 - 百度地图",
- "difficulty": 10
- },
- {
- "category": [
- "map",
- "lines"
- ],
- "id": "lines-bmap-effect",
- "ts": true,
- "tags": [
- "bmap"
- ],
- "title": "Bus Lines of Beijing - Line Effect",
- "titleCN": "北京公交路线 - 线特效",
- "difficulty": 10
- },
{
"category": [
"map",
@@ -3115,6 +3060,20 @@ export default [
"titleCN": "全国主要城市空气质量",
"difficulty": 2
},
+ {
+ "category": [
+ "heatmap"
+ ],
+ "id": "heatmap-bmap",
+ "ts": false,
+ "tags": [
+ "bmap"
+ ],
+ "noExplore": true,
+ "title": "Heatmap on Baidu Map Extension",
+ "titleCN": "热力图与百度地图扩展",
+ "difficulty": 3
+ },
{
"category": [
"heatmap"
@@ -3788,6 +3747,51 @@ export default [
"titleCN": "map and scatter share a geo",
"difficulty": 10
},
+ {
+ "category": [
+ "map",
+ "lines"
+ ],
+ "id": "lines-bmap",
+ "ts": true,
+ "tags": [
+ "bmap"
+ ],
+ "noExplore": true,
+ "title": "A Hiking Trail in Hangzhou - Baidu Map",
+ "titleCN": "杭州热门步行路线 - 百度地图",
+ "difficulty": 10
+ },
+ {
+ "category": [
+ "map",
+ "lines"
+ ],
+ "id": "lines-bmap-bus",
+ "ts": true,
+ "tags": [
+ "bmap"
+ ],
+ "noExplore": true,
+ "title": "Bus Lines of Beijing - Baidu Map",
+ "titleCN": "北京公交路线 - 百度地图",
+ "difficulty": 10
+ },
+ {
+ "category": [
+ "map",
+ "lines"
+ ],
+ "id": "lines-bmap-effect",
+ "ts": true,
+ "tags": [
+ "bmap"
+ ],
+ "noExplore": true,
+ "title": "Bus Lines of Beijing - Line Effect",
+ "titleCN": "北京公交路线 - 线特效",
+ "difficulty": 10
+ },
{
"category": [
"map"
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@echarts.apache.org
For additional commands, e-mail: commits-h...@echarts.apache.org
