From 09dc80276b6b544a7847bb4466e14e09e9c2e6e1 Mon Sep 17 00:00:00 2001 From: Yanyan Wang Date: Wed, 20 Oct 2021 10:03:32 +0800 Subject: [PATCH] docs: update cdn urls for docs (#3257) --- packages/site/docs/api/Items/itemMethods.zh.md | 6 ++++++ packages/site/docs/manual/FAQ/upgradeGuide.en.md | 10 +++++++--- packages/site/docs/manual/FAQ/upgradeGuide.zh.md | 10 +++++++--- packages/site/docs/manual/advanced/iconfont.en.md | 2 +- packages/site/docs/manual/advanced/iconfont.zh.md | 2 +- .../manual/advanced/mode-and-custom-behavior.en.md | 2 +- .../manual/advanced/mode-and-custom-behavior.zh.md | 2 +- packages/site/docs/manual/getting-started.en.md | 6 +++++- packages/site/docs/manual/getting-started.zh.md | 6 +++++- packages/site/docs/manual/middle/graph.en.md | 2 +- packages/site/docs/manual/middle/graph.zh.md | 2 +- .../docs/manual/middle/layout/layout-mechanism.en.md | 2 +- .../docs/manual/middle/layout/layout-mechanism.zh.md | 2 +- packages/site/docs/manual/tutorial/behavior.en.md | 2 ++ packages/site/docs/manual/tutorial/behavior.zh.md | 2 ++ packages/site/docs/manual/tutorial/elements.en.md | 2 ++ packages/site/docs/manual/tutorial/elements.zh.md | 2 ++ packages/site/docs/manual/tutorial/example.en.md | 2 ++ packages/site/docs/manual/tutorial/example.zh.md | 2 ++ packages/site/docs/manual/tutorial/layout.en.md | 2 ++ packages/site/docs/manual/tutorial/layout.zh.md | 2 ++ packages/site/docs/manual/tutorial/preface.en.md | 4 +++- packages/site/docs/manual/tutorial/preface.zh.md | 4 +++- packages/site/package.json | 2 +- 24 files changed, 61 insertions(+), 19 deletions(-) diff --git a/packages/site/docs/api/Items/itemMethods.zh.md b/packages/site/docs/api/Items/itemMethods.zh.md index 36f937de50e..236f301203e 100644 --- a/packages/site/docs/api/Items/itemMethods.zh.md +++ b/packages/site/docs/api/Items/itemMethods.zh.md @@ -5,22 +5,27 @@ order: 0 Item 是 G6 中绘图元素实例，目前包含节点和边的实例。对于实例的变更建议在 graph 上进行。 + ## 更新 ### item.update(model) + 根据元素数据项，更新元素。 **参数** + | 名称 | 类型 | 是否必选 | 描述 | | ----- | ------ | -------- | -------------------------- | | model | Object | true | 元素描述项，包括数据和样式 | + 提示： 其中参数 model 可包括以下属性，下面属性的详细描述参见 [元素配置项](/zh/docs/api/Items/itemProperties)： + | 名称 | 类型 | 是否必选 | 描述 | | -------- | ------ | -------- | ------------------------------------------ | | style | Object | false | 元素样式 | @@ -28,6 +33,7 @@ Item 是 G6 中绘图元素实例，目前包含节点和边的实例。对于 | label | String | false | 元素的文本标签，有该字段时默认会渲染 label | | labelCfg | Object | false | 元素文本标签的样式 | + **用法** ```javascript diff --git a/packages/site/docs/manual/FAQ/upgradeGuide.en.md b/packages/site/docs/manual/FAQ/upgradeGuide.en.md index a29dca80cf3..816fdb3cde9 100644 --- a/packages/site/docs/manual/FAQ/upgradeGuide.en.md +++ b/packages/site/docs/manual/FAQ/upgradeGuide.en.md @@ -19,7 +19,7 @@ G6 3.3.0 supports three build outcomes: The built outcomes of esm and commonjs do not support layouts with Web-Worker. -if you want to support layouts with Web-Worker, please use the file of [CDN](https://gw.alipayobjects.com/os/antv/pkg/_antv.g6-3.7.1/dist/g6.min.js). +if you want to support layouts with Web-Worker, please use the file of [CDN](https://gw.alipayobjects.com/os/lib/antv/g6/4.3.11/dist/g6.min.js). ## Util @@ -53,9 +53,13 @@ const grid = new Grid({ }) -// G6 3.5.10 +// G6 4.x // Import by CDN. Yuo only need to import G6. - + + +// address of G6 3.x +// + // Or import by NPM. Yuo only need to import G6. import G6 from '@antv/G6' diff --git a/packages/site/docs/manual/FAQ/upgradeGuide.zh.md b/packages/site/docs/manual/FAQ/upgradeGuide.zh.md index 960b8905d96..8a3825bc356 100644 --- a/packages/site/docs/manual/FAQ/upgradeGuide.zh.md +++ b/packages/site/docs/manual/FAQ/upgradeGuide.zh.md @@ -15,7 +15,7 @@ G6 3.3.0 支持三种构建产物： **其中 esm 及 commonjs 构建产物不支持 webworker 布局。** -如果要支持 webworker 布局，请引用 [CDN](https://gw.alipayobjects.com/os/antv/pkg/_antv.g6-3.7.1/dist/g6.min.js) 上的文件。 +如果要支持 webworker 布局，请引用 [CDN](https://gw.alipayobjects.com/os/lib/antv/g6/4.3.11/dist/g6.min.js) 上的文件。 ## Util @@ -49,9 +49,13 @@ const grid = new Grid({ }) -// G6 3.5 +// G6 4.x // CDN 引入，只需要引入 G6 - + + +// G6 3.x 引入地址 +// + // 或 NPM 引入，只需要引入 G6 import G6 from '@antv/G6' diff --git a/packages/site/docs/manual/advanced/iconfont.en.md b/packages/site/docs/manual/advanced/iconfont.en.md index 59494088144..db98534bb20 100644 --- a/packages/site/docs/manual/advanced/iconfont.en.md +++ b/packages/site/docs/manual/advanced/iconfont.en.md @@ -24,7 +24,7 @@ PS: The directory for this example is '/static/icons'. There are several ways to import G6 introduced in [Getting Started](/en/docs/manual/getting-started).
PS: We import G6 by CDN in this example. ```html - + ``` ## Import the Iconfont diff --git a/packages/site/docs/manual/advanced/iconfont.zh.md b/packages/site/docs/manual/advanced/iconfont.zh.md index 869604fdb54..02b5c2d94c7 100644 --- a/packages/site/docs/manual/advanced/iconfont.zh.md +++ b/packages/site/docs/manual/advanced/iconfont.zh.md @@ -24,7 +24,7 @@ PS: 本案文件目录为 '/static/icons'。 多种引入方式，请移步[快速上手](/zh/docs/manual/getting-started)。
PS: 本案例简单粗暴，通过 CDN 的方式引入。 ```html - + ``` ## 添加字体图标 diff --git a/packages/site/docs/manual/advanced/mode-and-custom-behavior.en.md b/packages/site/docs/manual/advanced/mode-and-custom-behavior.en.md index b614941718f..bd3b0f6f72a 100644 --- a/packages/site/docs/manual/advanced/mode-and-custom-behavior.en.md +++ b/packages/site/docs/manual/advanced/mode-and-custom-behavior.en.md @@ -42,7 +42,7 @@ Here goes the basic HTML code for this chapter. We will add new codes incrementa
- + + + +// version >= 4.0 + + ``` ⚠️Attention: @@ -136,7 +140,7 @@ graph.render(); // Render the graph
/* Import G6 by CDN */ - + + +// version >= 4.0 + + ``` ⚠️ 注意: @@ -136,7 +140,7 @@ graph.render(); // 渲染图
/* 引入 G6 */ - + + + + + + + + + + + + + + + + + + + + + + + + +