From 151a5761dbd5ff015dd947882d02e76762671a66 Mon Sep 17 00:00:00 2001 From: Aaron Date: Tue, 12 Dec 2023 14:52:07 +0800 Subject: [PATCH] docs: update g6 version and react-node usage (#5260) --- README.en-US.md | 2 +- README.md | 2 +- packages/react-node/README.md | 23 +++++++++++-------- .../docs/manual/tutorial/quick-start.en.md | 2 +- .../docs/manual/tutorial/quick-start.zh.md | 2 +- 5 files changed, 18 insertions(+), 13 deletions(-) diff --git a/README.en-US.md b/README.en-US.md index 1cfbfca6d43..77c2b51ef0e 100644 --- a/README.en-US.md +++ b/README.en-US.md @@ -69,7 +69,7 @@ G6 concentrates on the principle of 'good by default'. In addition, the custom m ## Installation (5.0 Alpha) ```bash -$ npm install @antv/g6@5.0.0-alpha.8 +$ npm install @antv/g6@5.0.0-beta.28 ``` ## Usage (5.0 Alpha) diff --git a/README.md b/README.md index 82025eccb73..2a9c6915259 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ GIF 未完整加载，[点此看原图](https://mdn.alipayobjects.com/huamei_qa8 ## 安装 (5.0 Alpha) ```bash -$ npm install @antv/g6@5.0.0-alpha.8 +$ npm install @antv/g6@5.0.0-beta.28 ``` ## 使用 (5.0 Alpha) diff --git a/packages/react-node/README.md b/packages/react-node/README.md index 4add37bb0e3..5c3c4ab7849 100644 --- a/packages/react-node/README.md +++ b/packages/react-node/README.md @@ -7,11 +7,22 @@ Using React Component to Define Your G6 Graph Node ## Usage -TODO +```bash +pnpm install @antv/g6-react-node@2.0.0-beta.1 +``` -## Options +```jsx +import { createReactNode, createReactGNode } from '@antv/g6-react-node'; + +const ReactNode = createReactNode({ + // ... React Component +}); + +const ReactGNode = createReactGNode({ + // ... JSX Component +}); +``` -TODO ## Development @@ -27,12 +38,6 @@ $ pnpm run build # build library source code in watch mode $ pnpm run build:watch - -# build docs -$ pnpm run docs:build - -# check your project for potential problems -$ pnpm run doctor ``` ## LICENSE diff --git a/packages/site/docs/manual/tutorial/quick-start.en.md b/packages/site/docs/manual/tutorial/quick-start.en.md index 931a3f933d4..1ee4e4cdfb2 100644 --- a/packages/site/docs/manual/tutorial/quick-start.en.md +++ b/packages/site/docs/manual/tutorial/quick-start.en.md @@ -81,7 +81,7 @@ Using G6 in vanilla HTML only requires importing the G6 JS file, as shown below: ```bash # Using npm -npm install --save @antv/g6@5.0.0 +npm install --save @antv/g6@5.0.0-beta.28 # Using yarn yarn add @antv/g6@5.0.0 diff --git a/packages/site/docs/manual/tutorial/quick-start.zh.md b/packages/site/docs/manual/tutorial/quick-start.zh.md index 211849daaf8..5330624304a 100644 --- a/packages/site/docs/manual/tutorial/quick-start.zh.md +++ b/packages/site/docs/manual/tutorial/quick-start.zh.md @@ -83,7 +83,7 @@ order: 1 ```bash # 使用 npm 安装 -npm install --save @antv/g6@5.0.0 +npm install --save @antv/g6@5.0.0-beta.28 # 使用 yarn 安装 yarn add @antv/g6@5.0.0