refactor: adjust v4 site (#6426)

* refactor: adjust v4 site * chore: update build workflow * chore: update site links
antvis · Oct 22, 2024 · a7080c5 · a7080c5
1 parent 49d2b57
commit a7080c5
Show file tree

Hide file tree

Showing 36 changed files with 410 additions and 421 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -17,27 +17,15 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 20
 
       - uses: pnpm/action-setup@v2
         name: Install pnpm
         with:
-          version: 8
+          version: 9
           run_install: false
 
-      - uses: actions/cache@v3
-        name: Setup pnpm cache
-        id: cache
-        with:
-          path: |
-            node_modules/
-            packages/g6/node_modules/
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
-
       - name: Install Dependencies
-        if: steps.cache.outputs.cache-hit != 'true'
         run: pnpm install --no-frozen-lockfile
 
       - name: Run CI

diff --git a/README.md b/README.md
@@ -6,13 +6,7 @@
 
 ![](https://user-images.githubusercontent.com/6113694/45008751-ea465300-b036-11e8-8e2a-166cbb338ce2.png)
 
-[![build](https://github.com/antvis/G6/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/antvis/G6/actions/)
-[![Coverage Status](https://coveralls.io/repos/github/antvis/G6/badge.svg?branch=master)](https://coveralls.io/github/antvis/G6?branch=master)
-![typescript](https://img.shields.io/badge/language-typescript-red.svg) 
-![MIT](https://img.shields.io/badge/license-MIT-000000.svg) 
-[![npm package](https://img.shields.io/npm/v/@antv/g6.svg)](https://www.npmjs.com/package/@antv/g6) 
-[![NPM downloads](http://img.shields.io/npm/dm/@antv/g6.svg)](https://npmjs.org/package/@antv/g6) 
-[![Percentage of issues still open](http://isitmaintained.com/badge/open/antvis/g6.svg)](http://isitmaintained.com/project/antvis/g6)
+[![build](https://github.com/antvis/G6/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/antvis/G6/actions/) [![Coverage Status](https://coveralls.io/repos/github/antvis/G6/badge.svg?branch=master)](https://coveralls.io/github/antvis/G6?branch=master) ![typescript](https://img.shields.io/badge/language-typescript-red.svg) ![MIT](https://img.shields.io/badge/license-MIT-000000.svg) [![npm package](https://img.shields.io/npm/v/@antv/g6.svg)](https://www.npmjs.com/package/@antv/g6) [![NPM downloads](http://img.shields.io/npm/dm/@antv/g6.svg)](https://npmjs.org/package/@antv/g6) [![Percentage of issues still open](http://isitmaintained.com/badge/open/antvis/g6.svg)](http://isitmaintained.com/project/antvis/g6)
 
 ## What is G6
 
@@ -110,7 +104,7 @@ graph.render();
 
 [![Edit compassionate-lalande-5lxm7](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/compassionate-lalande-5lxm7?fontsize=14&hidenavigation=1&theme=dark)
 
-For more information of the usage, please refer to [Getting Started](https://g6.antv.antgroup.com/en/manual/getting-started).
+For more information of the usage, please refer to [Getting Started](https://g6-v4.antv.vision/en/manual/getting-started).
 
 ## Development
 
@@ -138,10 +132,10 @@ DEBUG_MODE=1 npm test -- --watch ./tests/unit/algorithm/find-path-spec
 
 ## Documents
 
-- <a href='https://g6.antv.antgroup.com/en/manual/tutorial/preface' target='_blank'>Tutorial</a>
-- <a href='https://g6.antv.antgroup.com/en/manual/middle/overview' target='_blank'>Middle Guides</a>
-- <a href='https://g6.antv.antgroup.com/en/manual/advanced/coordinate-system' target='_blank'>Further Reading</a>
-- <a href='https://g6.antv.antgroup.com/en/api/graph' target='_blank'>API Reference</a>
+- <a href='https://g6-v4.antv.vision/en/manual/tutorial/preface' target='_blank'>Tutorial</a>
+- <a href='https://g6-v4.antv.vision/en/manual/middle/overview' target='_blank'>Middle Guides</a>
+- <a href='https://g6-v4.antv.vision/en/manual/advanced/coordinate-system' target='_blank'>Further Reading</a>
+- <a href='https://g6-v4.antv.vision/en/api/graph' target='_blank'>API Reference</a>
 
 ## React project integration
 
@@ -153,8 +147,8 @@ At present, Graphin has good practices in business graph analysis projects. For
 
 Welcome to join the **G6 Communication Group**. We also welcome the github issues.
 
-* DingTalk Group: 30088652
-* WeChat Group: Add WeChat **AntVG6** to join the group
+- DingTalk Group: 30088652
+- WeChat Group: Add WeChat **AntVG6** to join the group
 
 <img src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*j137TJmS1dEAAAAAAAAAAAAADmJ7AQ/original" width="200" />
 

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -6,13 +6,7 @@
 
 ![](https://user-images.githubusercontent.com/6113694/45008751-ea465300-b036-11e8-8e2a-166cbb338ce2.png)
 
-[![build](https://github.com/antvis/G6/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/antvis/G6/actions/)
-[![Coverage Status](https://coveralls.io/repos/github/antvis/G6/badge.svg?branch=master)](https://coveralls.io/github/antvis/G6?branch=master)
-![typescript](https://img.shields.io/badge/language-typescript-red.svg) 
-![MIT](https://img.shields.io/badge/license-MIT-000000.svg) 
-[![npm package](https://img.shields.io/npm/v/@antv/g6.svg)](https://www.npmjs.com/package/@antv/g6) 
-[![NPM downloads](http://img.shields.io/npm/dm/@antv/g6.svg)](https://npmjs.org/package/@antv/g6) 
-[![Percentage of issues still open](http://isitmaintained.com/badge/open/antvis/g6.svg)](http://isitmaintained.com/project/antvis/g6)
+[![build](https://github.com/antvis/G6/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/antvis/G6/actions/) [![Coverage Status](https://coveralls.io/repos/github/antvis/G6/badge.svg?branch=master)](https://coveralls.io/github/antvis/G6?branch=master) ![typescript](https://img.shields.io/badge/language-typescript-red.svg) ![MIT](https://img.shields.io/badge/license-MIT-000000.svg) [![npm package](https://img.shields.io/npm/v/@antv/g6.svg)](https://www.npmjs.com/package/@antv/g6) [![NPM downloads](http://img.shields.io/npm/dm/@antv/g6.svg)](https://npmjs.org/package/@antv/g6) [![Percentage of issues still open](http://isitmaintained.com/badge/open/antvis/g6.svg)](http://isitmaintained.com/project/antvis/g6)
 
 ## 什么是 G6
 
@@ -112,7 +106,7 @@ graph.render();
 
 [![Edit compassionate-lalande-5lxm7](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/compassionate-lalande-5lxm7?fontsize=14&hidenavigation=1&theme=dark)
 
-更多关于 G6 使用的问题，请参考[快速上手](https://g6.antv.antgroup.com/manual/getting-started)。
+更多关于 G6 使用的问题，请参考[快速上手](https://g6-v4.antv.vision/manual/getting-started)。
 
 ## 开发
 
@@ -140,10 +134,10 @@ DEBUG_MODE=1 npm test -- --watch ./tests/unit/algorithm/find-path-spec
 
 ## 文档
 
-- <a href='https://g6.antv.antgroup.com/manual/tutorial/preface' target='_blank'>入门教程</a>
-- <a href='https://g6.antv.antgroup.com/manual/middle/overview' target='_blank'>核心概念</a>
-- <a href='https://g6.antv.antgroup.com/manual/advanced/coordinate-system' target='_blank'>扩展阅读</a>
-- <a href='https://g6.antv.antgroup.com/api/graph' target='_blank'>API</a>
+- <a href='https://g6-v4.antv.vision/manual/tutorial/preface' target='_blank'>入门教程</a>
+- <a href='https://g6-v4.antv.vision/manual/middle/overview' target='_blank'>核心概念</a>
+- <a href='https://g6-v4.antv.vision/manual/advanced/coordinate-system' target='_blank'>扩展阅读</a>
+- <a href='https://g6-v4.antv.vision/api/graph' target='_blank'>API</a>
 
 ## React 项目集成
 
@@ -159,8 +153,8 @@ DEBUG_MODE=1 npm test -- --watch ./tests/unit/algorithm/find-path-spec
 
 > 由于维护精力有限，**G6 图可视化交流群** 仅供社区同学相互交流，不进行答疑。欢迎对 G6 感兴趣的同学加入到答疑中来，非常感谢！
 
-* 钉钉群：30088652
-* 微信群：添加微信 **AntVG6** 联系进群
+- 钉钉群：30088652
+- 微信群：添加微信 **AntVG6** 联系进群
 
 <img src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*j137TJmS1dEAAAAAAAAAAAAADmJ7AQ/original" width="200" />
 

diff --git a/packages/core/README.en-US.md b/packages/core/README.en-US.md
@@ -108,7 +108,7 @@ graph.render();
 
 [![Edit compassionate-lalande-5lxm7](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/compassionate-lalande-5lxm7?fontsize=14&hidenavigation=1&theme=dark)
 
-For more information of the usage, please refer to [Getting Started](https://g6.antv.antgroup.com/en/manual/getting-started).
+For more information of the usage, please refer to [Getting Started](https://g6-v4.antv.vision/en/manual/getting-started).
 
 ## Development
 
@@ -134,10 +134,10 @@ DEBUG_MODE=1 npm test -- --watch ./tests/unit/algorithm/find-path-spec
 
 ## Documents
 
-- <a href='https://g6.antv.antgroup.com/en/manual/tutorial/preface' target='_blank'>Tutorial</a>
-- <a href='https://g6.antv.antgroup.com/en/manual/middle/overview' target='_blank'>Middle Guides</a>
-- <a href='https://g6.antv.antgroup.com/en/manual/advanced/coordinate-system' target='_blank'>Further Reading</a>
-- <a href='https://g6.antv.antgroup.com/en/api/graph' target='_blank'>API Reference</a>
+- <a href='https://g6-v4.antv.vision/en/manual/tutorial/preface' target='_blank'>Tutorial</a>
+- <a href='https://g6-v4.antv.vision/en/manual/middle/overview' target='_blank'>Middle Guides</a>
+- <a href='https://g6-v4.antv.vision/en/manual/advanced/coordinate-system' target='_blank'>Further Reading</a>
+- <a href='https://g6-v4.antv.vision/en/api/graph' target='_blank'>API Reference</a>
 
 ## G6 Communication Group
 
@@ -151,7 +151,6 @@ Welcome to join the **G6 Communication Group** or **G6 Communication Group-2** (
 
 Please let us know what you are you going to help. Do check out [issues](https://github.com/antvis/g6/issues) for bug reports or suggestions first.
 
-
 ## License
 
 [MIT license](./LICENSE).
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -110,7 +110,7 @@ graph.render();
 
 [![Edit compassionate-lalande-5lxm7](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/compassionate-lalande-5lxm7?fontsize=14&hidenavigation=1&theme=dark)
 
-更多关于 G6 使用的问题，请参考[快速上手](https://g6.antv.antgroup.com/manual/getting-started)。
+更多关于 G6 使用的问题，请参考[快速上手](https://g6-v4.antv.vision/manual/getting-started)。
 
 ## 开发
 
@@ -136,10 +136,10 @@ DEBUG_MODE=1 npm test -- --watch ./tests/unit/algorithm/find-path-spec
 
 ## 文档
 
-- <a href='https://g6.antv.antgroup.com/manual/tutorial/preface' target='_blank'>入门教程</a>
-- <a href='https://g6.antv.antgroup.com/manual/middle/overview' target='_blank'>核心概念</a>
-- <a href='https://g6.antv.antgroup.com/manual/advanced/coordinate-system' target='_blank'>扩展阅读</a>
-- <a href='https://g6.antv.antgroup.com/api/graph' target='_blank'>API</a>
+- <a href='https://g6-v4.antv.vision/manual/tutorial/preface' target='_blank'>入门教程</a>
+- <a href='https://g6-v4.antv.vision/manual/middle/overview' target='_blank'>核心概念</a>
+- <a href='https://g6-v4.antv.vision/manual/advanced/coordinate-system' target='_blank'>扩展阅读</a>
+- <a href='https://g6-v4.antv.vision/api/graph' target='_blank'>API</a>
 
 ## G6 图可视化交流群
 

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -11,7 +11,7 @@
     "graph visualization",
     "relational data"
   ],
-  "homepage": "https://g6.antv.antgroup.com/",
+  "homepage": "https://g6-v4.antv.vision/",
   "bugs": {
     "url": "https://github.com/antvis/g6/issues"
   },

diff --git a/packages/core/src/types/index.ts b/packages/core/src/types/index.ts
@@ -21,7 +21,7 @@ export type CommonInteractionEvent =
   | 'dragenter'
   | 'dragleave'
   | 'dragover'
-  | 'dragout' // TODO: not in documentation page: https://g6.antv.antgroup.com/en/api/Event/
+  | 'dragout' // TODO: not in documentation page: https://g6-v4.antv.vision/en/api/Event/
   | 'drop'
   | 'focus'
   | 'blur'
@@ -116,8 +116,8 @@ export type CanvasInteractionEvent =
  * Canvas Intereaction events
  *
  * @example
- * English: https://g6.antv.antgroup.com/en/api/Event
- * Chinese: https://g6.antv.antgroup.com/api/Event
+ * English: https://g6-v4.antv.vision/en/api/Event
+ * Chinese: https://g6-v4.antv.vision/api/Event
  */
 export type GraphTimingEvents =
   | 'beforerender'
@@ -165,13 +165,7 @@ export type GraphTimingEvents =
   | 'beforedestroy'
   | 'afterdestroy';
 
-type MobileInteractionEvent =
-  | 'tap'
-  | 'pinchstart'
-  | 'pinmove'
-  | 'panstart'
-  | 'panmove'
-  | 'panend'
+type MobileInteractionEvent = 'tap' | 'pinchstart' | 'pinmove' | 'panstart' | 'panmove' | 'panend';
 
 export type NodeEventType = `node:${NodeInteractionEvent}`;
 export type EdgeEventType = `edge:${EdgeInteractionEvent}`;
@@ -185,9 +179,18 @@ export type MobileInteractionEventType = MobileInteractionEvent;
  * Graph interaction events
  *
  * @example
- * https://g6.antv.antgroup.com/en/api/Event#combo-interaction-event
+ * https://g6-v4.antv.vision/en/api/Event#combo-interaction-event
  */
-export type G6Event = NodeEventType | EdgeEventType | ComboEventType | CanvasEventType | GraphTimingEventType | MobileInteractionEventType | CommonInteractionEvent | CommonInteractionEvent | (string & {});
+export type G6Event =
+  | NodeEventType
+  | EdgeEventType
+  | ComboEventType
+  | CanvasEventType
+  | GraphTimingEventType
+  | MobileInteractionEventType
+  | CommonInteractionEvent
+  | CommonInteractionEvent
+  | (string & {});
 
 export interface IG6GraphEvent extends GraphEvent {
   item: Item | null;
@@ -328,11 +331,13 @@ export interface ModeOption {
   minZoom?: number;
   enableOptimize?: boolean;
   enableDebounce?: boolean;
-  allowDragOnItem?: boolean | {
-    node?: boolean,
-    edge?: boolean,
-    combo?: boolean
-  };
+  allowDragOnItem?:
+    | boolean
+    | {
+        node?: boolean;
+        edge?: boolean;
+        combo?: boolean;
+      };
   optimizeZoom?: number;
   multiple?: boolean;
   activeState?: string;
@@ -386,10 +391,10 @@ export interface States {
 
 export interface StateStyles {
   [key: string]:
-  | ShapeStyle
-  | {
-    [key: string]: ShapeStyle;
-  };
+    | ShapeStyle
+    | {
+        [key: string]: ShapeStyle;
+      };
 }
 
 // model types (node edge group)
@@ -464,7 +469,7 @@ export interface GraphOptions {
     size: number | number[];
     color: string;
   }> &
-  ModelStyle;
+    ModelStyle;
 
   /**
    * 默认状态下边的配置，比如 type, size, color。会被写入的 data 覆盖。
@@ -474,7 +479,7 @@ export interface GraphOptions {
     size: number | number[];
     color: string;
   }> &
-  ModelStyle;
+    ModelStyle;
 
   /**
    * Combo 默认配置
@@ -484,7 +489,7 @@ export interface GraphOptions {
     size: number | number[];
     color: string;
   }> &
-  ModelStyle;
+    ModelStyle;
 
   nodeStateStyles?: StateStyles;
 
@@ -624,10 +629,10 @@ export interface TreeGraphData {
   depth?: number;
   collapsed?: boolean;
   style?:
-  | ShapeStyle
-  | {
-    [key: string]: ShapeStyle;
-  };
+    | ShapeStyle
+    | {
+        [key: string]: ShapeStyle;
+      };
   stateStyles?: StateStyles;
   [key: string]: unknown;
 }
@@ -786,7 +791,6 @@ export interface GroupNodeIds {
   [key: string]: string[];
 }
 
-
 export type DefaultBehaviorType = IG6GraphEvent | string | number | object;
 
 export interface BehaviorOption {

diff --git a/packages/core/src/util/base.ts b/packages/core/src/util/base.ts
@@ -128,7 +128,7 @@ export const calculationItemsBBox = (items: Item[]) => {
 
 /**
  * 若 edges 中存在两端点相同的边，使用 quadratic 边并自动计算 curveOffset 使它们不相互重叠
- * 文档: https://g6.antv.antgroup.com/en/api/Util
+ * 文档: https://g6-v4.antv.vision/en/api/Util
  * @param edges 边数据集合
  * @param offsetDiff 相邻两边的 offset 之差
  * @param multiEdgeType
@@ -140,7 +140,7 @@ export const processParallelEdges = (
   offsetDiff = 15,
   multiEdgeType: string = 'quadratic',
   singleEdgeType: string = undefined,
-  loopEdgeType: string = undefined
+  loopEdgeType: string = undefined,
 ) => {
   const len = edges.length;
   const cod = offsetDiff * 2;

diff --git a/packages/element/README-zh_CN.md b/packages/element/README-zh_CN.md
@@ -108,7 +108,7 @@ graph.render();
 
 [![Edit compassionate-lalande-5lxm7](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/compassionate-lalande-5lxm7?fontsize=14&hidenavigation=1&theme=dark)
 
-更多关于 G6 使用的问题，请参考[快速上手](https://g6.antv.antgroup.com/manual/getting-started)。
+更多关于 G6 使用的问题，请参考[快速上手](https://g6-v4.antv.vision/manual/getting-started)。
 
 ## 开发
 
@@ -134,10 +134,10 @@ DEBUG_MODE=1 npm test -- --watch ./tests/unit/algorithm/find-path-spec
 
 ## 文档
 
-- <a href='https://g6.antv.antgroup.com/manual/tutorial/preface' target='_blank'>入门教程</a>
-- <a href='https://g6.antv.antgroup.com/manual/middle/overview' target='_blank'>核心概念</a>
-- <a href='https://g6.antv.antgroup.com/manual/advanced/coordinate-system' target='_blank'>扩展阅读</a>
-- <a href='https://g6.antv.antgroup.com/api/graph' target='_blank'>API</a>
+- <a href='https://g6-v4.antv.vision/manual/tutorial/preface' target='_blank'>入门教程</a>
+- <a href='https://g6-v4.antv.vision/manual/middle/overview' target='_blank'>核心概念</a>
+- <a href='https://g6-v4.antv.vision/manual/advanced/coordinate-system' target='_blank'>扩展阅读</a>
+- <a href='https://g6-v4.antv.vision/api/graph' target='_blank'>API</a>
 
 ## G6 图可视化交流群