docs: refactor structure (#5241)

antvis · Jul 26, 2023 · 9b012cb · 9b012cb
1 parent ceb5c35
commit 9b012cb
Show file tree

Hide file tree

Showing 78 changed files with 178 additions and 177 deletions.
diff --git a/site/.dumirc.ts b/site/.dumirc.ts
@@ -33,7 +33,7 @@ export default defineConfig({
     showWxQrcode: true, // 是否显示头部菜单的微信公众号
     showChartResize: true, // 是否在 demo 页展示图表视图切换
     showAPIDoc: true, // 是否在 demo 页展示API文档
-    showSpecTab: true, // 是否展示 Spec 页面
+    showSpecTab: true, // 是否展示 component 页面
     es5: false, // 案例代码是否编译到 es5
     versions: {
       // 历史版本以及切换下拉菜单
@@ -51,16 +51,16 @@ export default defineConfig({
       {
         slug: 'docs/manual/introduction',
         title: {
-          zh: '教程',
-          en: 'Tutorials',
+          zh: '文档',
+          en: 'Docs',
         },
         order: 3,
       },
       {
         slug: 'docs/spec/overview',
         title: {
-          zh: '文档',
-          en: 'Documentation',
+          zh: '选项',
+          en: 'Spec',
         },
         order: 2,
       },
@@ -80,13 +80,6 @@ export default defineConfig({
         },
         order: 0,
       },
-      // {
-      //   slug: 'theme',
-      //   title: {
-      //     zh: '主题',
-      //     en: 'Theme',
-      //   },
-      // },
     ],
     ecosystems: [
       // 头部的菜单中的「周边生态」
@@ -101,28 +94,28 @@ export default defineConfig({
     docs: [
       // manual
       {
-        slug: 'manual/single-view',
+        slug: 'manual/introduction',
         title: {
-          zh: '基础',
-          en: 'General',
+          zh: '简介',
+          en: 'Introduction',
         },
-        order: 3,
+        order: 1,
       },
       {
-        slug: 'manual/theme',
+        slug: 'manual/core',
         title: {
-          zh: '风格',
-          en: 'Style',
+          zh: '核心概念',
+          en: 'Core Concepts',
         },
-        order: 10,
+        order: 2,
       },
       {
-        slug: 'manual/more',
+        slug: 'manual/extra-topics',
         title: {
-          zh: '更多',
-          en: 'More',
+          zh: '进阶主题',
+          en: 'Extra Topics',
         },
-        order: 11,
+        order: 3,
       },
       // docs
       {

diff --git a/site/docs/manual/animation.en.md b/site/docs/manual/animation.en.md
diff --git a/site/docs/manual/color.en.md b/site/docs/manual/color.en.md
diff --git a/site/docs/manual/core/animation.en.md b/site/docs/manual/core/animation.en.md
@@ -0,0 +1,6 @@
+---
+title: Animation
+order: 7
+---
+
+<embed src="@/docs/manual/core/animation.zh.md"></embed>
diff --git a/site/docs/manual/animation.zh.md → site/docs/manual/core/animation.zh.md b/site/docs/manual/animation.zh.md → site/docs/manual/core/animation.zh.md
diff --git a/site/docs/manual/core/annotation.en.md b/site/docs/manual/core/annotation.en.md
@@ -0,0 +1,6 @@
+---
+title: Label
+order: 10
+---
+
+<embed src="@/docs/manual/core/annotation.zh.md"></embed>
diff --git a/.../docs/manual/single-view/annotation.zh.md → site/docs/manual/core/annotation.zh.md b/.../docs/manual/single-view/annotation.zh.md → site/docs/manual/core/annotation.zh.md
diff --git a/site/docs/manual/core/api.en.md b/site/docs/manual/core/api.en.md
@@ -0,0 +1,6 @@
+---
+title: API
+order: 2
+---
+
+<embed src="@/docs/manual/core/api.zh.md"></embed>
diff --git a/site/docs/manual/single-view/api.zh.md → site/docs/manual/core/api.zh.md b/site/docs/manual/single-view/api.zh.md → site/docs/manual/core/api.zh.md
diff --git a/site/docs/manual/core/chart.en.md b/site/docs/manual/core/chart.en.md
@@ -0,0 +1,6 @@
+---
+title: Chart
+order: 1
+---
+
+<embed src="@/docs/manual/core/chart.zh.md"></embed>
diff --git a/site/docs/manual/single-view/chart.zh.md → site/docs/manual/core/chart.zh.md b/site/docs/manual/single-view/chart.zh.md → site/docs/manual/core/chart.zh.md
diff --git a/site/docs/manual/core/component.en.md b/site/docs/manual/core/component.en.md
@@ -0,0 +1,6 @@
+---
+title: Component
+order: 9
+---
+
+<embed src="@/docs/manual/core/component.zh.md"></embed>
diff --git a/site/docs/manual/single-view/component.zh.md → site/docs/manual/core/component.zh.md b/site/docs/manual/single-view/component.zh.md → site/docs/manual/core/component.zh.md
diff --git a/site/docs/manual/core/composition.en.md b/site/docs/manual/core/composition.en.md
@@ -0,0 +1,6 @@
+---
+title: Composition
+order: 5
+---
+
+<embed src="@/docs/manual/core/view-composition.zh.md"></embed>
diff --git a/site/docs/manual/core/coordinate.en.md b/site/docs/manual/core/coordinate.en.md
@@ -0,0 +1,6 @@
+---
+title: Coordinate
+order: 8
+---
+
+<embed src="@/docs/manual/core/coordinate.zh.md"></embed>
diff --git a/.../docs/manual/single-view/coordinate.zh.md → site/docs/manual/core/coordinate.zh.md b/.../docs/manual/single-view/coordinate.zh.md → site/docs/manual/core/coordinate.zh.md
diff --git a/site/docs/manual/core/data.en.md b/site/docs/manual/core/data.en.md
@@ -0,0 +1,6 @@
+---
+title: Data
+order: 5
+---
+
+<embed src="@/docs/manual/core/data.zh.md"></embed>
diff --git a/site/docs/manual/single-view/data.zh.md → site/docs/manual/core/data.zh.md b/site/docs/manual/single-view/data.zh.md → site/docs/manual/core/data.zh.md
diff --git a/site/docs/manual/core/interaction.en.md b/site/docs/manual/core/interaction.en.md
@@ -0,0 +1,6 @@
+---
+title: Interaction
+order: 8
+---
+
+<embed src="@/docs/manual/core/interaction.zh.md"></embed>
diff --git a/site/docs/manual/interaction.zh.md → site/docs/manual/core/interaction.zh.md b/site/docs/manual/interaction.zh.md → site/docs/manual/core/interaction.zh.md
diff --git a/site/docs/manual/core/label.en.md b/site/docs/manual/core/label.en.md
@@ -0,0 +1,6 @@
+---
+title: Label
+order: 10
+---
+
+<embed src="@/docs/manual/core/label.zh.md"></embed>
diff --git a/site/docs/manual/single-view/label.zh.md → site/docs/manual/core/label.zh.md b/site/docs/manual/single-view/label.zh.md → site/docs/manual/core/label.zh.md
diff --git a/site/docs/manual/core/mark.en.md b/site/docs/manual/core/mark.en.md
@@ -0,0 +1,6 @@
+---
+title: Mark
+order: 4
+---
+
+<embed src="@/docs/manual/core/mark.zh.md"></embed>
diff --git a/site/docs/manual/single-view/mark.zh.md → site/docs/manual/core/mark.zh.md b/site/docs/manual/single-view/mark.zh.md → site/docs/manual/core/mark.zh.md
diff --git a/site/docs/manual/core/scale.en.md b/site/docs/manual/core/scale.en.md
@@ -0,0 +1,6 @@
+---
+title: Scale
+order: 7
+---
+
+<embed src="@/docs/manual/core/scale.zh.md"></embed>
diff --git a/site/docs/manual/single-view/scale.zh.md → site/docs/manual/core/scale.zh.md b/site/docs/manual/single-view/scale.zh.md → site/docs/manual/core/scale.zh.md
diff --git a/site/docs/manual/core/size.en.md b/site/docs/manual/core/size.en.md
@@ -0,0 +1,6 @@
+---
+title: Size
+order: 3
+---
+
+<embed src="@/docs/manual/core/size.zh.md"></embed>
diff --git a/site/docs/manual/single-view/size.zh.md → site/docs/manual/core/size.zh.md b/site/docs/manual/single-view/size.zh.md → site/docs/manual/core/size.zh.md
diff --git a/site/docs/manual/core/theme.en.md b/site/docs/manual/core/theme.en.md
@@ -0,0 +1,6 @@
+---
+title: Theme
+order: 9
+---
+
+<embed src="@/docs/manual/core/theme.zh.md"></embed>
diff --git a/site/docs/manual/theme/theme.zh.md → site/docs/manual/core/theme.zh.md b/site/docs/manual/theme/theme.zh.md → site/docs/manual/core/theme.zh.md
diff --git a/site/docs/manual/core/tooltip.en.md b/site/docs/manual/core/tooltip.en.md
@@ -0,0 +1,6 @@
+---
+title: Tooltip
+order: 11
+---
+
+<embed src="@/docs/manual/core/tooltip.zh.md"></embed>
diff --git a/site/docs/manual/single-view/tooltip.zh.md → site/docs/manual/core/tooltip.zh.md b/site/docs/manual/single-view/tooltip.zh.md → site/docs/manual/core/tooltip.zh.md
diff --git a/site/docs/manual/core/transform.en.md b/site/docs/manual/core/transform.en.md
@@ -0,0 +1,6 @@
+---
+title: Transform
+order: 6
+---
+
+<embed src="@/docs/manual/core/transform.zh.md"></embed>
diff --git a/site/docs/manual/single-view/transform.zh.md → site/docs/manual/core/transform.zh.md b/site/docs/manual/single-view/transform.zh.md → site/docs/manual/core/transform.zh.md
diff --git a/site/docs/manual/view-composition.zh.md → site/docs/manual/core/view-composition.zh.md b/site/docs/manual/view-composition.zh.md → site/docs/manual/core/view-composition.zh.md
diff --git a/site/docs/manual/customization.en.md b/site/docs/manual/customization.en.md
diff --git a/site/docs/manual/event.en.md b/site/docs/manual/event.en.md
diff --git a/site/docs/manual/extra-topics/color.en.md b/site/docs/manual/extra-topics/color.en.md
@@ -0,0 +1,6 @@
+---
+title: Event
+order: 9
+---
+
+<embed src="@/docs/manual/extra-topics/color.zh.md"></embed>
diff --git a/site/docs/manual/color.zh.md → site/docs/manual/extra-topics/color.zh.md b/site/docs/manual/color.zh.md → site/docs/manual/extra-topics/color.zh.md
diff --git a/site/docs/manual/extra-topics/customization.en.md b/site/docs/manual/extra-topics/customization.en.md
@@ -0,0 +1,6 @@
+---
+title: Customization
+order: 8
+---
+
+<embed src="@/docs/manual/extra-topics/customization.zh.md"></embed>
diff --git a/site/docs/manual/customization.zh.md → ...s/manual/extra-topics/customization.zh.md b/site/docs/manual/customization.zh.md → ...s/manual/extra-topics/customization.zh.md
diff --git a/site/docs/manual/extra-topics/event.en.md b/site/docs/manual/extra-topics/event.en.md
@@ -0,0 +1,6 @@
+---
+title: Event
+order: 9
+---
+
+<embed src="@/docs/manual/extra-topics/event.zh.md"></embed>
diff --git a/site/docs/manual/event.zh.md → site/docs/manual/extra-topics/event.zh.md b/site/docs/manual/event.zh.md → site/docs/manual/extra-topics/event.zh.md
diff --git a/site/docs/manual/extra-topics/experimental-spec-api.en.md b/site/docs/manual/extra-topics/experimental-spec-api.en.md
@@ -0,0 +1,6 @@
+---
+title: Experimental Spec API
+order: 1
+---
+
+<embed src="@/docs/manual/extra-topics/experimental-spec-api.zh.md"></embed>
diff --git a/...s/manual/more/experimental-spec-api.zh.md → .../extra-topics/experimental-spec-api.zh.md b/...s/manual/more/experimental-spec-api.zh.md → .../extra-topics/experimental-spec-api.zh.md
diff --git a/site/docs/manual/extra-topics/migration-from-g2v4.en.md b/site/docs/manual/extra-topics/migration-from-g2v4.en.md
@@ -0,0 +1,6 @@
+---
+title: G2 5.0 Migration Guide
+order: 3
+---
+
+<embed src="@/docs/manual/extra-topics/migration-from-g2v4.zh.md"></embed>
diff --git a/...ocs/manual/more/migration-from-g2v4.zh.md → ...al/extra-topics/migration-from-g2v4.zh.md b/...ocs/manual/more/migration-from-g2v4.zh.md → ...al/extra-topics/migration-from-g2v4.zh.md
diff --git a/site/docs/manual/extra-topics/pattern.en.md b/site/docs/manual/extra-topics/pattern.en.md
@@ -0,0 +1,6 @@
+---
+title: Pattern
+order: 10
+---
+
+<embed src="@/docs/manual/extra-topics/pattern.zh.md"></embed>
diff --git a/site/docs/manual/theme/pattern.zh.md → site/docs/manual/extra-topics/pattern.zh.md b/site/docs/manual/theme/pattern.zh.md → site/docs/manual/extra-topics/pattern.zh.md
diff --git a/site/docs/manual/extra-topics/use-in-framework.en.md b/site/docs/manual/extra-topics/use-in-framework.en.md
@@ -0,0 +1,6 @@
+---
+title: Use In Framework
+order: 1
+---
+
+<embed src="@/docs/manual/extra-topics/use-in-framework.zh.md"></embed>
diff --git a/site/docs/manual/more/use-in-framework.zh.md → ...anual/extra-topics/use-in-framework.zh.md b/site/docs/manual/more/use-in-framework.zh.md → ...anual/extra-topics/use-in-framework.zh.md
diff --git a/site/docs/manual/getting-started.en.md b/site/docs/manual/getting-started.en.md
diff --git a/site/docs/manual/interaction.en.md b/site/docs/manual/interaction.en.md
diff --git a/site/docs/manual/introduction.en.md b/site/docs/manual/introduction.en.md
diff --git a/site/docs/manual/introduction/getting-started.en.md b/site/docs/manual/introduction/getting-started.en.md
@@ -0,0 +1,6 @@
+---
+title: Getting Started
+order: 3
+---
+
+<embed src="@/docs/manual/introduction/getting-started.zh.md"></embed>
diff --git a/site/docs/manual/getting-started.zh.md → ...manual/introduction/getting-started.zh.md b/site/docs/manual/getting-started.zh.md → ...manual/introduction/getting-started.zh.md
@@ -1,6 +1,6 @@
 ---
-title: 快速上手
-order: 2
+title: 开始使用
+order: 3
 ---
 
 目前有两种使用 G2 的方式：

diff --git a/site/docs/manual/introduction/what-is-g2.en.md b/site/docs/manual/introduction/what-is-g2.en.md
@@ -0,0 +1,6 @@
+---
+title: What is G2？
+order: 1
+---
+
+<embed src="@/docs/manual/introduction/what-is-g2.zh.md"></embed>
diff --git a/site/docs/manual/introduction.zh.md → ...docs/manual/introduction/what-is-g2.zh.md b/site/docs/manual/introduction.zh.md → ...docs/manual/introduction/what-is-g2.zh.md
@@ -1,5 +1,5 @@
 ---
-title: 简介
+title: 什么是 G2
 order: 1
 ---
 

diff --git a/site/docs/manual/introduction/why-g2.en.md b/site/docs/manual/introduction/why-g2.en.md
@@ -0,0 +1,4 @@
+---
+title: Why G2?
+order: 2
+---
diff --git a/site/docs/manual/introduction/why-g2.zh.md b/site/docs/manual/introduction/why-g2.zh.md
@@ -0,0 +1,4 @@
+---
+title: 为什么选 G2？
+order: 2
+---
diff --git a/site/docs/manual/more/experimental-spec-api.en.md b/site/docs/manual/more/experimental-spec-api.en.md
diff --git a/site/docs/manual/more/migration-from-g2v4.en.md b/site/docs/manual/more/migration-from-g2v4.en.md
diff --git a/site/docs/manual/more/use-in-framework.en.md b/site/docs/manual/more/use-in-framework.en.md
diff --git a/site/docs/manual/single-view/annotation.en.md b/site/docs/manual/single-view/annotation.en.md
diff --git a/site/docs/manual/single-view/api.en.md b/site/docs/manual/single-view/api.en.md
diff --git a/site/docs/manual/single-view/chart.en.md b/site/docs/manual/single-view/chart.en.md
diff --git a/site/docs/manual/single-view/component.en.md b/site/docs/manual/single-view/component.en.md