fix: 升级官网主题 & 修复文档命名错误 (#2508)

* chore: update gatsby-theme-antv * docs: 修复文档命名错误 * docs: 图表组件增加 slider 的 api 文档，增加说明
antvis · Apr 21, 2021 · 50999c3 · 50999c3
1 parent 1623ca8
commit 50999c3
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 15 deletions.
diff --git a/docs/common/component-tiny-en.md → docs/common/component-tiny.en.md b/docs/common/component-tiny-en.md → docs/common/component-tiny.en.md
diff --git a/docs/common/component.en.md b/docs/common/component.en.md
@@ -19,3 +19,7 @@ Same for xAxis and yAxis. **Note**: Since `DualAxes` or `BidirectionalBar` has d
 #### annotations
 
 `markdown:docs/common/annotations.en.md`
+
+#### slider
+
+`markdown:docs/common/slider.en.md`
diff --git a/docs/common/component.zh.md b/docs/common/component.zh.md
@@ -19,3 +19,7 @@ xAxis、yAxis 配置相同。**注意**：由于 DualAxes(双轴图) 和 Bidirec
 #### annotations
 
 `markdown:docs/common/annotations.zh.md`
+
+#### slider
+
+`markdown:docs/common/slider.zh.md`
diff --git a/docs/common/slider.en.md b/docs/common/slider.en.md
@@ -1,15 +1,15 @@
-Object type refer to [ShapeAttrs](/en/docs/api/graphic-style)
+> Only line plot, area plot and dual-axes plot are supported.
 
 | Properties      | Type           | Description                             |
 | --------------- | -------------- | --------------------------------------- |
 | start           | _number_       | Default starting position               |
 | end             | _number_       | Default ending position                 |
 | height          | _number_       | Slider height                           |
 | trendCfg        | _TrendCfg_     | Configuration of background trends      |
-| backgroundStyle | _object_       | Background style                        |
-| foregroundStyle | _object_       | Foreground style                        |
+| backgroundStyle | _object_       | Background style, reference[Graphic Style](/en/docs/api/graphic-style)                        |
+| foregroundStyle | _object_       | Foreground style, reference[Graphic Style](/en/docs/api/graphic-style)                        |
 | handlerStyle    | _HandlerStyle_ | Handler configuration                   |
-| textStyle       | _object_       | Text style                              |
+| textStyle       | _object_       | Text style, reference[Graphic Style](/en/docs/api/graphic-style)                              |
 | minLimit        | _number_       | Lower limit of sliding position allowed |
 | maxLimit        | _number_       | Upper limit of sliding position allowed |
 | formatter       | _Function_     | Slider text formatting function         |
@@ -21,9 +21,9 @@ Types of __*TrendCfg*__  are as follow:
 | data            | _number[]_ | Trend data                     |
 | smooth          | _boolean_  | Whether smooth                 |
 | isArea          | _boolean_  | Whether area                   |
-| backgroundStyle | _object_   | Background style configuration |
-| lineStyle       | _object_   | Line style configuration       |
-| areaStyle       | _object_   | Area style configuration       |
+| backgroundStyle | _object_   | Background style configuration, reference[Graphic Style](/en/docs/api/graphic-style) |
+| lineStyle       | _object_   | Line style configuration, reference[Graphic Style](/en/docs/api/graphic-style)       |
+| areaStyle       | _object_   | Area style configuration, reference[Graphic Style](/en/docs/api/graphic-style)       |
 
 Types of __*HandlerStyle*__ are as follow:
 

diff --git a/docs/common/slider.zh.md b/docs/common/slider.zh.md
@@ -1,15 +1,15 @@
-object 类型的请参考[绘图属性](/zh/docs/api/graphic-style)
+> 目前只适用于：折线图、面积图、双轴图。
 
 | 配置项          | 类型           | 功能描述           |
 | --------------- | -------------- | ------------------ |
 | start           | _number_       | 默认起始位置       |
 | end             | _number_       | 默认结束位置       |
 | height          | _number_       | 缩略轴高度         |
 | trendCfg        | _TrendCfg_     | 背景趋势的配置     |
-| backgroundStyle | _object_       | 背景配置           |
-| foregroundStyle | _object_       | 背景配置           |
+| backgroundStyle | _object_       | 背景配置，参考[绘图属性](/zh/docs/api/graphic-style)           |
+| foregroundStyle | _object_       | 前景配置，参考[绘图属性](/zh/docs/api/graphic-style)          |
 | handlerStyle    | _HandlerStyle_ | handler 配置       |
-| textStyle       | _object_       | 文本配置           |
+| textStyle       | _object_       | 文本配置，参考[绘图属性](/zh/docs/api/graphic-style)          |
 | minLimit        | _number_       | 允许滑动位置下限   |
 | maxLimit        | _number_       | 允许滑动位置上限   |
 | formatter       | _Function_     | 滑块文本格式化函数 |
@@ -21,9 +21,9 @@ __*TrendCfg*__ 类型如下：
 | data            | _number[]_ | 统计文本的样式 |
 | smooth          | _boolean_  | 是否平滑       |
 | isArea          | _boolean_  | 是否面积图     |
-| backgroundStyle | _object_   | 背景样式配置   |
-| lineStyle       | _object_   | line 样式配置  |
-| areaStyle       | _object_   | area 样式配置  |
+| backgroundStyle | _object_   | 背景样式配置，参考[绘图属性](/zh/docs/api/graphic-style)   |
+| lineStyle       | _object_   | line 样式配置，参考[绘图属性](/zh/docs/api/graphic-style)  |
+| areaStyle       | _object_   | area 样式配置，参考[绘图属性](/zh/docs/api/graphic-style)  |
 
 __*HandlerStyle*__ 类型如下：
 

diff --git a/package.json b/package.json
@@ -63,7 +63,7 @@
   },
   "devDependencies": {
     "@antv/data-set": "^0.11.5",
-    "@antv/gatsby-theme-antv": "^1.0.4",
+    "@antv/gatsby-theme-antv": "^1.1.2",
     "@babel/core": "^7.10.4",
     "@babel/plugin-transform-runtime": "^7.11.5",
     "@babel/preset-env": "^7.10.4",