docs: add manual dirs

antvis · Nov 15, 2022 · 7b3cf33 · 7b3cf33
1 parent 2b301ff
commit 7b3cf33
Show file tree

Hide file tree

Showing 39 changed files with 319 additions and 19 deletions.
diff --git a/site/.dumirc.ts b/site/.dumirc.ts
@@ -44,15 +44,15 @@ export default defineConfig({
     navs: [
       // 头部的菜单列表
       {
-        slug: 'manual/getting-started',
+        slug: 'docs/manual/introduction',
         title: {
           zh: '教程',
           en: 'Tutorials',
         },
         order: 2,
       },
       {
-        slug: 'api/chart',
+        slug: 'docs/api/overview',
         title: {
           zh: 'API',
           en: 'API',
@@ -79,6 +79,7 @@ export default defineConfig({
       },
     ],
     docs: [
+      // manual
       {
         slug: 'manual/single-view',
         title: {
@@ -90,21 +91,124 @@ export default defineConfig({
       {
         slug: 'manual/multi-view',
         title: {
-          zh: '多视图图表',
-          en: 'Multi-View Plot',
+          zh: '复合视图图表',
+          en: 'Multi- View Plot',
         },
         order: 4,
       },
-    ],
-    tutorials: [
-      // 一个 🌰
+      // api
       {
-        slug: 'manual/about',
+        slug: 'api/data',
         title: {
-          zh: '关于',
-          en: 'About',
+          zh: 'Data',
+          en: '数据',
         },
-        order: 1,
+        order: 3,
+      },
+      {
+        slug: 'api/mark',
+        title: {
+          zh: 'Mark',
+          en: 'Mark',
+        },
+        order: 4,
+      },
+      {
+        slug: 'api/transform',
+        title: {
+          zh: 'Transform',
+          en: 'Transform',
+        },
+        order: 5,
+      },
+      {
+        slug: 'api/scale',
+        title: {
+          zh: 'Scale',
+          en: '比例尺',
+        },
+        order: 6,
+      },
+      {
+        slug: 'api/coordinate',
+        title: {
+          zh: 'Coordinate',
+          en: '坐标系',
+        },
+        order: 7,
+      },
+      {
+        slug: 'api/composition',
+        title: {
+          zh: 'Composition',
+          en: 'Composition',
+        },
+        order: 8,
+      },
+      {
+        slug: 'api/component',
+        title: {
+          zh: 'Component',
+          en: '组件',
+        },
+        order: 9,
+      },
+      {
+        slug: 'api/label',
+        title: {
+          zh: 'Label',
+          en: '数据标签',
+        },
+        order: 10,
+      },
+
+      {
+        slug: 'api/animation',
+        title: {
+          zh: 'Animation',
+          en: '动画',
+        },
+        order: 11,
+      },
+      {
+        slug: 'api/interaction',
+        title: {
+          zh: 'Interaction',
+          en: '交互',
+        },
+        order: 12,
+      },
+      {
+        slug: 'api/graph',
+        title: {
+          zh: 'Graph',
+          en: '图',
+        },
+        order: 13,
+      },
+      {
+        slug: 'api/geo',
+        title: {
+          zh: 'Geo',
+          en: '地图',
+        },
+        order: 14,
+      },
+      {
+        slug: 'api/theme',
+        title: {
+          zh: 'Theme',
+          en: '主题',
+        },
+        order: 15,
+      },
+      {
+        slug: 'api/plugin',
+        title: {
+          zh: 'Plugin',
+          en: '扩展插件',
+        },
+        order: 15,
       },
     ],
     examples: [

diff --git a/site/docs/api/animation/fade-in.en.md b/site/docs/api/animation/fade-in.en.md
@@ -0,0 +1,6 @@
+---
+title: fadeIn
+order: 1
+---
+
+<embed src="@/docs/api/animation/fade-in.zh.md"></embed>
diff --git a/site/docs/api/animation/fade-in.zh.md b/site/docs/api/animation/fade-in.zh.md
@@ -0,0 +1,6 @@
+---
+title: fadeIn
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/chart.en.md b/site/docs/api/chart.en.md
@@ -1,4 +1,6 @@
 ---
 title: Chart
-order: 1
----
+order: 2
+---
+
+<embed src="@/docs/api/chart.zh.md"></embed>
diff --git a/site/docs/api/chart.zh.md b/site/docs/api/chart.zh.md
@@ -1,4 +1,6 @@
 ---
 title: Chart
-order: 1
----
+order: 2
+---
+
+建设中！
diff --git a/site/docs/api/component/axis.en.md b/site/docs/api/component/axis.en.md
@@ -0,0 +1,6 @@
+---
+title: polar
+order: 1
+---
+
+<embed src="@/docs/api/component/axis.zh.md"></embed>
diff --git a/site/docs/api/component/axis.zh.md b/site/docs/api/component/axis.zh.md
@@ -0,0 +1,6 @@
+---
+title: polar
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/composition/space-layer.en.md b/site/docs/api/composition/space-layer.en.md
@@ -0,0 +1,6 @@
+---
+title: polar
+order: 1
+---
+
+<embed src="@/docs/api/composition/space-layer.zh.md"></embed>
diff --git a/site/docs/api/composition/space-layer.zh.md b/site/docs/api/composition/space-layer.zh.md
@@ -0,0 +1,6 @@
+---
+title: polar
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/coordinate/polar.en.md b/site/docs/api/coordinate/polar.en.md
@@ -0,0 +1,6 @@
+---
+title: polar
+order: 1
+---
+
+<embed src="@/docs/api/coordinate/polar.zh.md"></embed>
diff --git a/site/docs/api/coordinate/polar.zh.md b/site/docs/api/coordinate/polar.zh.md
@@ -0,0 +1,6 @@
+---
+title: polar
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/data/overview.en.md b/site/docs/api/data/overview.en.md
@@ -0,0 +1,6 @@
+---
+title: Overview
+order: 1
+---
+
+<embed src="@/docs/api/data/overview.zh.md"></embed>
diff --git a/site/docs/api/data/overview.zh.md b/site/docs/api/data/overview.zh.md
@@ -0,0 +1,6 @@
+---
+title: 概览
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/data/sort-by.en.md b/site/docs/api/data/sort-by.en.md
@@ -0,0 +1,6 @@
+---
+title: sortBy
+order: 1
+---
+
+<embed src="@/docs/api/data/sort-by.zh.md"></embed>
diff --git a/site/docs/api/data/sort-by.zh.md b/site/docs/api/data/sort-by.zh.md
@@ -0,0 +1,6 @@
+---
+title: sortBy
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/geo/geo-path.en.md b/site/docs/api/geo/geo-path.en.md
@@ -0,0 +1,6 @@
+---
+title: geoPath
+order: 1
+---
+
+<embed src="@/docs/api/geo/geo-path.zh.md"></embed>
diff --git a/site/docs/api/geo/geo-path.zh.md b/site/docs/api/geo/geo-path.zh.md
@@ -0,0 +1,6 @@
+---
+title: geoPath
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/graph/sankey.en.md b/site/docs/api/graph/sankey.en.md
@@ -0,0 +1,6 @@
+---
+title: sankey
+order: 1
+---
+
+<embed src="@/docs/api/graph/sankey.zh.md"></embed>
diff --git a/site/docs/api/graph/sankey.zh.md b/site/docs/api/graph/sankey.zh.md
@@ -0,0 +1,6 @@
+---
+title: sankey
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/interaction/overview.en.md b/site/docs/api/interaction/overview.en.md
@@ -0,0 +1,6 @@
+---
+title: Overview
+order: 1
+---
+
+<embed src="@/docs/api/interaction/overview.zh.md"></embed>
diff --git a/site/docs/api/interaction/overview.zh.md b/site/docs/api/interaction/overview.zh.md
@@ -0,0 +1,6 @@
+---
+title: 概览
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/label/overview.en.md b/site/docs/api/label/overview.en.md
@@ -0,0 +1,6 @@
+---
+title: Overview
+order: 1
+---
+
+<embed src="@/docs/api/label/overview.zh.md"></embed>
diff --git a/site/docs/api/label/overview.zh.md b/site/docs/api/label/overview.zh.md
@@ -0,0 +1,6 @@
+---
+title: 概览
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/mark/interval.en.md b/site/docs/api/mark/interval.en.md
@@ -0,0 +1,6 @@
+---
+title: Interval
+order: 1
+---
+
+<embed src="@/docs/api/mark/interval.zh.md"></embed>
diff --git a/site/docs/api/mark/interval.zh.md b/site/docs/api/mark/interval.zh.md
@@ -0,0 +1,6 @@
+---
+title: Interval
+order: 1
+---
+
+Interval
diff --git a/site/docs/api/overview.en.md b/site/docs/api/overview.en.md
@@ -0,0 +1,6 @@
+---
+title: Overview
+order: 1
+---
+
+<embed src="@/docs/api/overview.zh.md"></embed>
diff --git a/site/docs/api/overview.zh.md b/site/docs/api/overview.zh.md
@@ -0,0 +1,6 @@
+---
+title: 概览
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/plugin/rough.en.md b/site/docs/api/plugin/rough.en.md
@@ -0,0 +1,6 @@
+---
+title: linear
+order: 1
+---
+
+<embed src="@/docs/api/plugin/rough.zh.md"></embed>
diff --git a/site/docs/api/plugin/rough.zh.md b/site/docs/api/plugin/rough.zh.md
@@ -0,0 +1,6 @@
+---
+title: linear
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/scale/linear.en.md b/site/docs/api/scale/linear.en.md
@@ -0,0 +1,6 @@
+---
+title: linear
+order: 1
+---
+
+<embed src="@/docs/api/scale/linear.zh.md"></embed>
diff --git a/site/docs/api/scale/linear.zh.md b/site/docs/api/scale/linear.zh.md
@@ -0,0 +1,6 @@
+---
+title: linear
+order: 1
+---
+
+建设中！
diff --git a/site/docs/api/theme/theme.en.md b/site/docs/api/theme/theme.en.md
@@ -0,0 +1,6 @@
+---
+title: theme
+order: 2
+---
+
+<embed src="@/docs/api/theme/theme.zh.md"></embed>