fix docs

refinajs · Jan 2, 2024 · 212530a · 212530a · vercel · Jan 2, 2024
1 parent 7988b8e
commit 212530a
Show file tree

Hide file tree

Showing 29 changed files with 54 additions and 49 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -19,6 +19,7 @@ export default defineConfig({
     resolve: {
       alias: {
         snippets: "/snippets",
+        helpers: "/helpers",
       },
     },
   },

diff --git a/docs/guide/quick-start.md b/docs/guide/quick-start.md
@@ -4,7 +4,8 @@
 
 - Familiarity with the command line
 - Install [Node.js](https://nodejs.org/) version 20.0 or higher
-  :::
+
+:::
 
 In this section, we will introduce how to scaffold a Refina app on your local machine. The created project will be using a build setup based on [Vite](https://vitejs.dev).
 
@@ -30,7 +31,8 @@ This command will install and execute [create-refina](https://github.com/refinaj
 - `postcss` The CSS preprocessor used by Vite.
 - `autoprefixer` The PostCSS plugin that adds vendor prefixes to CSS rules.
 - `tailwindcss` The CSS framework used by Refina.
-  :::
+
+:::
 
 Once the project is created, follow the instructions to install dependencies and start the dev server:
 

diff --git a/docs/std-comps/helpers/chip.vue → docs/helpers/chip.vue b/docs/std-comps/helpers/chip.vue → docs/helpers/chip.vue
diff --git a/docs/std-comps/helpers/kind.vue → docs/helpers/kind.vue b/docs/std-comps/helpers/kind.vue → docs/helpers/kind.vue
diff --git a/docs/std-comps/helpers/optional.vue → docs/helpers/optional.vue b/docs/std-comps/helpers/optional.vue → docs/helpers/optional.vue
diff --git a/docs/std-comps/button.md b/docs/std-comps/button.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Button` Component

diff --git a/docs/std-comps/checkbox.md b/docs/std-comps/checkbox.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Checkbox` Component

diff --git a/docs/std-comps/dialog.md b/docs/std-comps/dialog.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Dialog` Component

diff --git a/docs/std-comps/list.md b/docs/std-comps/list.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `List` Component

diff --git a/docs/std-comps/nav-rail.md b/docs/std-comps/nav-rail.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `NavRail` Component

diff --git a/docs/std-comps/radio-group.md b/docs/std-comps/radio-group.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `RadioGroup` Component

diff --git a/docs/std-comps/slider.md b/docs/std-comps/slider.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Slider` Component

diff --git a/docs/std-comps/switch.md b/docs/std-comps/switch.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Switch` Component

diff --git a/docs/std-comps/table.md b/docs/std-comps/table.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Table` Component

diff --git a/docs/std-comps/tabs.md b/docs/std-comps/tabs.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Tabs` Component

diff --git a/docs/std-comps/text-field.md b/docs/std-comps/text-field.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `TextField` Component

diff --git a/docs/zh/guide/apis/directives.md b/docs/zh/guide/apis/directives.md
@@ -80,7 +80,7 @@ $app(_ => {
 
 ## `_.$ref` {#ref}
 
-参见 [元素引用](../guide/essentials/lowlevel#ref-element)。
+参见 [元素引用](../essentials/lowlevel#ref-element)。
 
 ## `_.$props` {#props}
 

diff --git a/docs/zh/guide/quick-start.md b/docs/zh/guide/quick-start.md
@@ -4,7 +4,8 @@
 
 - 熟悉命令行
 - 已安装 20.0 或更高版本的 [Node.js](https://nodejs.org/)。
-  :::
+
+:::
 
 在本节中，我们将介绍如何在本地搭建 Refina 应用。 创建的项目将使用基于 [Vite](https://vitejs.dev) 的构建设置。
 
@@ -30,7 +31,8 @@
 - `postcss` CSS 预处理器。
 - `autoprefixer` 自动补全 CSS 的浏览器前缀。
 - `tailwindcss` 原子化 CSS 框架。
-  :::
+
+:::
 
 在项目被创建后，通过以下步骤安装依赖并启动开发服务器：
 

diff --git a/docs/zh/std-comps/button.md b/docs/zh/std-comps/button.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Button` Component

diff --git a/docs/zh/std-comps/checkbox.md b/docs/zh/std-comps/checkbox.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Checkbox` Component

diff --git a/docs/zh/std-comps/dialog.md b/docs/zh/std-comps/dialog.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Dialog` Component

diff --git a/docs/zh/std-comps/list.md b/docs/zh/std-comps/list.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `List` Component

diff --git a/docs/zh/std-comps/nav-rail.md b/docs/zh/std-comps/nav-rail.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `NavRail` Component

diff --git a/docs/zh/std-comps/radio-group.md b/docs/zh/std-comps/radio-group.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `RadioGroup` Component

diff --git a/docs/zh/std-comps/slider.md b/docs/zh/std-comps/slider.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Slider` Component

diff --git a/docs/zh/std-comps/switch.md b/docs/zh/std-comps/switch.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Switch` Component

diff --git a/docs/zh/std-comps/table.md b/docs/zh/std-comps/table.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Table` Component

diff --git a/docs/zh/std-comps/tabs.md b/docs/zh/std-comps/tabs.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `Tabs` Component

diff --git a/docs/zh/std-comps/text-field.md b/docs/zh/std-comps/text-field.md
@@ -1,6 +1,6 @@
 <script setup>
-import Kind from "./helpers/kind.vue";
-import Optional from "./helpers/optional.vue";
+import Kind from "helpers/kind.vue";
+import Optional from "helpers/optional.vue";
 </script>
 
 # The `TextField` Component