docs: 迁移和弦图文档地址 & 文档样式优化 & 修复绘图属性文档链接 404 (#2172)

* docs(chord): 迁移和弦图文档地址 * docs: 文档优化 * docs: 修复绘图属性文档链接 404 * docs: 删除无用文档 & 修改文档链接 * docs: 修改文档错别字 * docs: 文档锚点大小写问题
antvis · Jan 5, 2021 · 79dc60b · 79dc60b
1 parent 536adf9
commit 79dc60b
Show file tree

Hide file tree

Showing 15 changed files with 59 additions and 58 deletions.
diff --git a/docs/api/components/legend.zh.md b/docs/api/components/legend.zh.md
@@ -38,8 +38,8 @@ legend: {
 | flipPage | _boolean_ | false | 当图例项过多时是否进行分页。 | <tag color="green" text="分类图例">分类图例</tag> |
 | itemWidth | _number\|null_ | null | 图例项的宽度, 默认为 null（自动计算）。 | <tag color="green" text="分类图例">分类图例</tag> |
 | itemHeight | _number\|null_ | null | 图例的高度, 默认为 null。 | <tag color="green" text="分类图例">分类图例</tag> |
-| itemName | _object_ | - | 图例项 name 文本的配置。详见 [itemName 配置](#itemName) | <tag color="green" text="分类图例">分类图例</tag> |
-| itemValue | _object_ | - | 图例项 value 附加值的配置项。详见 [itemValue 配置](#itemValue)。 | <tag color="green" text="分类图例">分类图例</tag> |
+| itemName | _object_ | - | 图例项 name 文本的配置。详见 [itemName 配置](#itemname) | <tag color="green" text="分类图例">分类图例</tag> |
+| itemValue | _object_ | - | 图例项 value 附加值的配置项。详见 [itemValue 配置](#itemvalue)。 | <tag color="green" text="分类图例">分类图例</tag> |
 | itemSpacing | _number_ | - | 控制图例项水平方向的间距 | <tag color="green" text="分类图例">分类图例</tag> |
 | animate | _boolean_ | - | 是否开启动画开关。 |  |
 | animateOption | _object_ | - | 动画参数配置，当且仅当 animate 属性为 true，即动画开启时生效，详见 [animateOption 配置](#animateOption) |  |

diff --git a/docs/api/plots/gauge.zh.md b/docs/api/plots/gauge.zh.md
@@ -50,7 +50,7 @@ order: 22
 | 配置项 | 类型     | 描述                                 |
 | ------ | -------- | ------------------------------------ |
 | ticks  | _number[]_ | 辅助圆弧显示数字数组                 |
-| color  | _string/|string[]_ | 辅助圆弧的颜色色板，按照色板顺序取值; 当设置 ticks 时，color 无法使用回调的方式 |
+| color  | _string \|string[]_ | 辅助圆弧的颜色色板，按照色板顺序取值; 当设置 ticks 时，color 无法使用回调的方式 |
 
 <playground rid="gauge" path="progress-plots/gauge/demo/basic.ts"></playground>
 

diff --git a/docs/common/annotations.en.md b/docs/common/annotations.en.md
@@ -131,10 +131,10 @@ y 方向的偏移量。
 
 文字包围盒样式设置。
 
-| 参数名  | 类型                | 是否必选 | 默认值 | 描述               |
+| 参数名  | 类型                | 默认值 | 描述               |
 | ------- | ------------------- | -------- | ------ | ------------------ |
-| style   | object 参考绘图属性 |          | -      | 文本背景的样式     |
-| padding | number \| number[]  |          | -      | 文本背景周围的留白 |
+| style   | _object_ | -      | 文本背景的样式, 参考[绘图属性](/en/docs/api/graphic-style)     |
+| padding | _number \| number[]_ | -      | 文本背景周围的留白 |
 
 ##### color
 

diff --git a/docs/common/annotations.zh.md b/docs/common/annotations.zh.md
@@ -131,10 +131,11 @@ y 方向的偏移量。
 
 文字包围盒样式设置。
 
-| 参数名  | 类型                | 是否必选 | 默认值 | 描述               |
+| 参数名  | 类型                | 默认值 | 描述               |
 | ------- | ------------------- | -------- | ------ | ------------------ |
-| style   | object 参考绘图属性 |          | -      | 文本背景的样式     |
-| padding | number \| number[]  |          | -      | 文本背景周围的留白 |
+| style   | _object_ | -      | 文本背景的样式, 参考[绘图属性](/en/docs/api/graphic-style)     |
+| padding | _number \| number[]_ | -      | 文本背景周围的留白 |
+
 
 ##### color
 

diff --git a/docs/manual/plots/chord.en.md → docs/common/chord.en.md b/docs/manual/plots/chord.en.md → docs/common/chord.en.md
diff --git a/docs/manual/plots/chord.zh.md → docs/common/chord.zh.md b/docs/manual/plots/chord.zh.md → docs/common/chord.zh.md
diff --git a/docs/common/conversion-tag.en.md b/docs/common/conversion-tag.en.md
@@ -25,4 +25,4 @@ TextCfg 配置如下
 | style     | object                               | 否       | -      | 箭头样式         |
 | formatter | (prev:number, next:number) => string | 否       | -      | 自定义转化率计算 |
 
-样式配置类型请参考[绘图属性](../../manual/graphic-style)
+样式配置类型请参考[ShapeAttrs](/en/docs/api/graphic-style)
diff --git a/docs/common/conversion-tag.zh.md b/docs/common/conversion-tag.zh.md
@@ -25,4 +25,4 @@ TextCfg 配置如下
 | style     | object                               | 否       | -      | 箭头样式         |
 | formatter | (prev:number, next:number) => string | 否       | -      | 自定义转化率计算 |
 
-样式配置类型请参考[绘图属性](../../manual/graphic-style)
+样式配置类型请参考[绘图属性](/zh/docs/api/graphic-style)
diff --git a/docs/common/legend-cfg.zh.md b/docs/common/legend-cfg.zh.md
@@ -49,7 +49,7 @@
 | 参数名 | 类型 | 默认值 | 描述 |
 | --- | --- | --- | --- |
 | size | _number_ | - | 滑块的大小 |
-| style | _object_ | - | 滑块的样式设置，参考 [绘图属性](../graphic-style) |
+| style | _object_ | - | 滑块的样式设置，参考 [绘图属性](/zh/docs/api/graphic-style) |
 
 ##### itemHeight
 
@@ -71,7 +71,7 @@
 
 | 参数名 | 类型 | 默认值 | 描述 |
 | --- | --- | --- | --- |
-| style | _object_ | - | 文本样式配置项，参考 [绘图属性](../graphic-style) |
+| style | _object_ | - | 文本样式配置项，参考 [绘图属性](/zh/docs/api/graphic-style) |
 | spacing | _number_ | `false` | 图例项 marker 同后面 name 的间距 |
 | formatter | _function_ | - | 格式化函数, `(text: string, item: ListItem, index: number) => any;` |
 
@@ -89,7 +89,7 @@
 
 | 参数名 | 类型 | 默认值 | 描述 |
 | --- | --- | --- | --- |
-| style | _object_ | - | 文本样式配置项，详见 [绘图属性](../graphic-style) |
+| style | _object_ | - | 文本样式配置项，详见 [绘图属性](/zh/docs/api/graphic-style) |
 | alignRight | _boolean_ | `false` | 是否右对齐，默认为 false，仅当设置图例项宽度时生效 |
 | formatter | _function_ | - | 格式化函数, `(text: string, item: ListItem, index: number) => any;` |
 
@@ -116,7 +116,7 @@
 | 参数名 | 类型 | 默认值 | 描述 |
 | --- | --- | --- | --- |
 | align | _string_ | - | 文本同滑轨的对齐方式 <br/> - rail ： 同滑轨对齐，在滑轨的两端 <br/> - top, bottom: 图例水平布局时有效 <br/> - left, right: 图例垂直布局时有效 |
-| style | _object_ | - | 文本样式配置项，详见 [绘图属性](../graphic-style) |
+| style | _object_ | - | 文本样式配置项，详见 [绘图属性](/zh/docs/api/graphic-style) |
 | spacing | _number_ | - | 文本同滑轨的距离 |
 
 ##### marker
@@ -173,7 +173,7 @@
 | type | _string_ | - | rail 的类型，color, size |
 | size | _number_ | - | 滑轨的宽度 |
 | defaultLength | _number_ | - | 滑轨的默认长度，，当限制了 maxWidth,maxHeight 时，不会使用这个属性会自动计算长度 |
-| style | _object_ | - | 滑轨的样式，参考 [绘图属性](../graphic-style) |
+| style | _object_ | - | 滑轨的样式，参考 [绘图属性](/zh/docs/api/graphic-style) |
 ##### reversed
 
 <description>**optional** _boolean_ </description>
@@ -193,7 +193,7 @@
 | 参数名 | 类型 | 默认值 | 描述 |
 | --- | --- | --- | --- |
 | spacing | _number_ | - | 标题同图例项的间距 |
-| style | _object_ | - | 文本样式配置项，参考 [绘图属性](../graphic-style) |
+| style | _object_ | - | 文本样式配置项，参考 [绘图属性](/zh/docs/api/graphic-style) |
 
 ##### track
 
@@ -202,7 +202,7 @@
 
 | 参数名 | 类型 | 默认值 | 描述 |
 | --- | --- | --- | --- |
-| style | _object_ | - | 选定范围的样式，参考 [绘图属性](../graphic-style) |
+| style | _object_ | - | 选定范围的样式，参考 [绘图属性](/zh/docs/api/graphic-style) |
 
 ##### values
 

diff --git a/docs/common/shape-style.en.md b/docs/common/shape-style.en.md
@@ -36,4 +36,4 @@ Example：
 }
 ```
 
-More documents about `ShapeStyle`, see [Graphic Style](../graphic-style).
+More documents about `ShapeStyle`, see [Graphic Style](/en/docs/api/graphic-style).
diff --git a/docs/common/shape-style.zh.md b/docs/common/shape-style.zh.md
@@ -36,4 +36,4 @@
 }
 ```
 
-关于 ShapeStyle 更加详细的文档参考 [绘图属性](../graphic-style)。
+关于 ShapeStyle 更加详细的文档参考 [绘图属性](/zh/docs/api/graphic-style)。
diff --git a/docs/common/slider.en.md b/docs/common/slider.en.md
@@ -1,26 +1,26 @@
-object 类型的请参考[绘图属性](../../manual/graphic-style)
+object 类型的请参考[ShapeAttrs](/en/docs/api/graphic-style)
 
 | 配置项          | 类型     | 功能描述           |
 | --------------- | -------- | ------------------ |
-| start           | number   | 默认起始位置       |
-| end             | number   | 默认结束位置       |
-| height          | number   | 缩略轴高度         |
-| trendCfg        | trendCfg | 背景趋势的配置     |
-| backgroundStyle | object   | 背景配置           |
-| foregroundStyle | object   | 背景配置           |
-| handlerStyle    | object   | handle 配置        |
-| textStyle       | object   | 文本配置           |
-| minLimit        | number   | 允许滑动位置下限   |
-| maxLimit        | number   | 允许滑动位置上限   |
-| formatter       | Function | 滑块文本格式化函数 |
+| start           | _number_    | 默认起始位置       |
+| end             | _number_    | 默认结束位置       |
+| height          | _number_    | 缩略轴高度         |
+| trendCfg        | _trendCfg_ | 背景趋势的配置     |
+| backgroundStyle | _object_    | 背景配置           |
+| foregroundStyle | _object_    | 背景配置           |
+| handlerStyle    | _object_    | handle 配置        |
+| textStyle       | _object_    | 文本配置           |
+| minLimit        | _number_    | 允许滑动位置下限   |
+| maxLimit        | _number_    | 允许滑动位置上限   |
+| formatter       | _Function_ | 滑块文本格式化函数 |
 
 trendCfg
 
 | 配置项          | 类型     | 功能描述       |
 | --------------- | -------- | -------------- |
-| data            | number[] | 统计文本的样式 |
-| smooth          | boolean  | 是否平滑       |
-| isArea          | boolean  | 是否面积图     |
-| backgroundStyle | object   | 背景样式配置   |
-| lineStyle       | object   | line 样式配置  |
-| areaStyle       | object   | area 样式配置  |
+| data            | _number[]_ | 统计文本的样式 |
+| smooth          | _boolean_   | 是否平滑       |
+| isArea          | _boolean_   | 是否面积图     |
+| backgroundStyle | _object_    | 背景样式配置   |
+| lineStyle       | _object_    | line 样式配置  |
+| areaStyle       | _object_    | area 样式配置  |
diff --git a/docs/common/slider.zh.md b/docs/common/slider.zh.md
@@ -1,26 +1,26 @@
-object 类型的请参考[绘图属性](../../manual/graphic-style)
+object 类型的请参考[绘图属性](/zh/docs/api/graphic-style)
 
 | 配置项          | 类型     | 功能描述           |
 | --------------- | -------- | ------------------ |
-| start           | number   | 默认起始位置       |
-| end             | number   | 默认结束位置       |
-| height          | number   | 缩略轴高度         |
-| trendCfg        | trendCfg | 背景趋势的配置     |
-| backgroundStyle | object   | 背景配置           |
-| foregroundStyle | object   | 背景配置           |
-| handlerStyle    | object   | handle 配置        |
-| textStyle       | object   | 文本配置           |
-| minLimit        | number   | 允许滑动位置下限   |
-| maxLimit        | number   | 允许滑动位置上限   |
-| formatter       | Function | 滑块文本格式化函数 |
+| start           | _number_    | 默认起始位置       |
+| end             | _number_    | 默认结束位置       |
+| height          | _number_    | 缩略轴高度         |
+| trendCfg        | _trendCfg_ | 背景趋势的配置     |
+| backgroundStyle | _object_    | 背景配置           |
+| foregroundStyle | _object_    | 背景配置           |
+| handlerStyle    | _object_    | handle 配置        |
+| textStyle       | _object_    | 文本配置           |
+| minLimit        | _number_    | 允许滑动位置下限   |
+| maxLimit        | _number_    | 允许滑动位置上限   |
+| formatter       | _Function_ | 滑块文本格式化函数 |
 
 trendCfg
 
 | 配置项          | 类型     | 功能描述       |
 | --------------- | -------- | -------------- |
-| data            | number[] | 统计文本的样式 |
-| smooth          | boolean  | 是否平滑       |
-| isArea          | boolean  | 是否面积图     |
-| backgroundStyle | object   | 背景样式配置   |
-| lineStyle       | object   | line 样式配置  |
-| areaStyle       | object   | area 样式配置  |
+| data            | _number[]_ | 统计文本的样式 |
+| smooth          | _boolean_   | 是否平滑       |
+| isArea          | _boolean_   | 是否面积图     |
+| backgroundStyle | _object_    | 背景样式配置   |
+| lineStyle       | _object_    | line 样式配置  |
+| areaStyle       | _object_    | area 样式配置  |
diff --git a/docs/manual/upgrade.en.md b/docs/manual/upgrade.en.md
@@ -40,7 +40,7 @@ G2Plot 2.0 is compatible with most of the chart functions and configuration item
 | description | 不再支持                                                                | -                                                                                                              |
 | forceFit    | 不再支持，改用 autoFit                                                  | -                                                                                                              |
 | responsive  | 不再支持，内置                                                          | -                                                                                                              |
-| guideLine   | 不再支持，改用 [anniotations](../../examples/general/annotation) 实现。 | -                                                                                                              |
+| guideLine   | 不再支持，改用 [annotations](../../examples/general/annotation) 实现。 | -                                                                                                              |
 | label       | label.type 会有兼容性问题，如果报错修改 type 配置或者去掉               | -                                                                                                              |
 | slider      | 写法变更                                                                | <img src="https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*IZmLQaZ8ANMAAAAAAAAAAAAAARQnAQ" alt="示例" /> |
 | scrollbar   | 写法变更                                                                | <img src="https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*Zq3NSpae7NEAAAAAAAAAAAAAARQnAQ" alt="示例" /> |

diff --git a/docs/manual/upgrade.zh.md b/docs/manual/upgrade.zh.md
@@ -40,7 +40,7 @@ G2Plot 2.0 兼容大部分的 1.x 版本图表功能和配置项，详情如下
 | description | 不再支持                                                                | -                                                                                                              |
 | forceFit    | 不再支持，改用 autoFit                                                  | -                                                                                                              |
 | responsive  | 不再支持，内置                                                          | -                                                                                                              |
-| guideLine   | 不再支持，改用 [anniotations](../../examples/general/annotation) 实现。 | -                                                                                                              |
+| guideLine   | 不再支持，改用 [annotations](../../examples/general/annotation) 实现。 | -                                                                                                              |
 | label       | label.type 会有兼容性问题，如果报错修改 type 配置或者去掉               | -                                                                                                              |
 | slider      | 写法变更                                                                | <img src="https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*IZmLQaZ8ANMAAAAAAAAAAAAAARQnAQ" alt="示例" /> |
 | scrollbar   | 写法变更                                                                | <img src="https://gw.alipayobjects.com/mdn/rms_d314dd/afts/img/A*Zq3NSpae7NEAAAAAAAAAAAAAARQnAQ" alt="示例" /> |
-Original file line number
+Diff line change
@@ Expand Up / @@ -36,4 +36,4 @@ Example： @@
     }
     ```
-    More documents about `ShapeStyle`, see [Graphic Style](../graphic-style).
+    More documents about `ShapeStyle`, see [Graphic Style](/en/docs/api/graphic-style).