diff --git a/packages/ui-vue/docs/.vitepress/config/index.ts b/packages/ui-vue/docs/.vitepress/config/index.ts index ea10bd3e6124ee91ba84e0cebd8080d8fb2220e1..f3e64dcad0b8abdd2b0ebc31f34d5a858c950d80 100644 --- a/packages/ui-vue/docs/.vitepress/config/index.ts +++ b/packages/ui-vue/docs/.vitepress/config/index.ts @@ -1,6 +1,7 @@ import { defineConfig } from 'vitepress'; import head from './head'; import nav from './nav'; +import sidebar from './sidebar'; import markdown from './markdown'; const config = defineConfig({ @@ -10,6 +11,7 @@ const config = defineConfig({ markdown, themeConfig: { nav, + sidebar, logo: '../../assets/farris_design.jpg' } }); diff --git a/packages/ui-vue/docs/.vitepress/config/nav.ts b/packages/ui-vue/docs/.vitepress/config/nav.ts index d3b1b14623aef9350d2a3c6db685a5d51b90cc41..fd0545d10214f04e8e9a597c2e277aaf1d79fcf4 100644 --- a/packages/ui-vue/docs/.vitepress/config/nav.ts +++ b/packages/ui-vue/docs/.vitepress/config/nav.ts @@ -1,3 +1,3 @@ -const nav = [{ text: '组件', link: '/quick-start/' }]; +const nav = [{ text: '组件', link: '/components/' }]; export default nav; diff --git a/packages/ui-vue/docs/.vitepress/config/sidebar.ts b/packages/ui-vue/docs/.vitepress/config/sidebar.ts new file mode 100644 index 0000000000000000000000000000000000000000..2c9ca96d274c940c1d2baddd9c2e7aee706a7f6c --- /dev/null +++ b/packages/ui-vue/docs/.vitepress/config/sidebar.ts @@ -0,0 +1,53 @@ +const sidebar = [ + { + text: '介绍', + items: [{ text: '快速开始', link: '/guide/quick-start/' }] + }, + { + text: '通用', + items: [ + { text: 'Button 按钮', link: '/components/button/' }, + { text: 'Icon 图标', link: '/components/icon/' } + ] + }, + { + text: '导航', + items: [{ text: 'Accordion 手风琴', link: '/components/accordion/' }] + }, + { + text: '布局', + items: [ + { + text: 'section 面板', + link: '/components/section/' + }, + { text: 'tabs 标签页', link: '/components/tabs/' } + ] + }, + { + text: '录入数据', + items: [ + { text: 'Button Edit 按钮输入框', link: '/components/button-edit/' }, + { text: 'Radio Group 单选组', link: '/components/radio-group/' }, + { text: 'Text 静态文本', link: '/components/text/' }, + { text: 'Combo List 选择输入框', link: '/components/combo-list/' }, + { text: 'Swtich 开关', link: '/components/switch/' } + ] + }, + { + text: '展示数据', + items: [ + { text: 'Avatar 头像', link: '/components/avatar/' }, + { text: 'tooltip 提示信息', link: '/components/tooltip/' } + ] + }, + { + text: '反馈', + items: [ + { text: 'notify 通知消息', link: '/components/notify/' }, + { text: 'popover 气泡提示', link: '/components/popover/' } + ] + } +]; + +export default sidebar; diff --git a/packages/ui-vue/docs/components/accordion/index.md b/packages/ui-vue/docs/components/accordion/index.md new file mode 100644 index 0000000000000000000000000000000000000000..4b0b7ed14e9ad073b76be4d347e444f29fdf6c0b --- /dev/null +++ b/packages/ui-vue/docs/components/accordion/index.md @@ -0,0 +1 @@ +# Accordion \ No newline at end of file diff --git a/packages/ui-vue/docs/components/avatar/index.md b/packages/ui-vue/docs/components/avatar/index.md new file mode 100644 index 0000000000000000000000000000000000000000..588a866484e000e200f4bb036afb331dbdc61209 --- /dev/null +++ b/packages/ui-vue/docs/components/avatar/index.md @@ -0,0 +1 @@ +# Avatar \ No newline at end of file diff --git a/packages/ui-vue/docs/components/button-edit/index.md b/packages/ui-vue/docs/components/button-edit/index.md new file mode 100644 index 0000000000000000000000000000000000000000..076d88a08ddd54b215bd0bda1c5d669c5a4ccea9 --- /dev/null +++ b/packages/ui-vue/docs/components/button-edit/index.md @@ -0,0 +1,23 @@ +# Button Edit 按钮输入框 + +## 基本用法 + +## 对齐方式 + +## 状态 + +## 按钮 + +## 清空按钮 + +## 文本标签 + +## 提示信息 + +## 类型 + +## 属性 + +## 事件 + +## 插槽 \ No newline at end of file diff --git a/packages/ui-vue/docs/components/button/index.md b/packages/ui-vue/docs/components/button/index.md new file mode 100644 index 0000000000000000000000000000000000000000..4fa718b1c055a22d240e50e5a1a2e6025b3c8bb6 --- /dev/null +++ b/packages/ui-vue/docs/components/button/index.md @@ -0,0 +1 @@ +# Button \ No newline at end of file diff --git a/packages/ui-vue/docs/components/combo-list/index.md b/packages/ui-vue/docs/components/combo-list/index.md new file mode 100644 index 0000000000000000000000000000000000000000..30e38f747dcebe86610408707436304e4c182624 --- /dev/null +++ b/packages/ui-vue/docs/components/combo-list/index.md @@ -0,0 +1 @@ +# Combo List \ No newline at end of file diff --git a/packages/ui-vue/docs/components/icon/index.md b/packages/ui-vue/docs/components/icon/index.md new file mode 100644 index 0000000000000000000000000000000000000000..5edd6ec22507d4c45ee63b34b8266ef5e770c1e9 --- /dev/null +++ b/packages/ui-vue/docs/components/icon/index.md @@ -0,0 +1 @@ +# Icon diff --git a/packages/ui-vue/docs/components/index.md b/packages/ui-vue/docs/components/index.md new file mode 100644 index 0000000000000000000000000000000000000000..9cfcd55677ae4f23df64775097bc91324bbc5781 --- /dev/null +++ b/packages/ui-vue/docs/components/index.md @@ -0,0 +1 @@ +# 组件集合 \ No newline at end of file diff --git a/packages/ui-vue/docs/components/notify/index.md b/packages/ui-vue/docs/components/notify/index.md new file mode 100644 index 0000000000000000000000000000000000000000..78d8669be96f58ce479d32c2d13ea9d04d4ea7a8 --- /dev/null +++ b/packages/ui-vue/docs/components/notify/index.md @@ -0,0 +1 @@ +# Notify \ No newline at end of file diff --git a/packages/ui-vue/docs/components/popover/index.md b/packages/ui-vue/docs/components/popover/index.md new file mode 100644 index 0000000000000000000000000000000000000000..e749bfb8ac7324ead5404f5a4c9fc7f5ec98ef03 --- /dev/null +++ b/packages/ui-vue/docs/components/popover/index.md @@ -0,0 +1 @@ +# Popover \ No newline at end of file diff --git a/packages/ui-vue/docs/components/radio-group/index.md b/packages/ui-vue/docs/components/radio-group/index.md new file mode 100644 index 0000000000000000000000000000000000000000..7782affa45fc8392df3095f8f8728c21028567c2 --- /dev/null +++ b/packages/ui-vue/docs/components/radio-group/index.md @@ -0,0 +1 @@ +# Radio Group \ No newline at end of file diff --git a/packages/ui-vue/docs/components/section/index.md b/packages/ui-vue/docs/components/section/index.md new file mode 100644 index 0000000000000000000000000000000000000000..de7cc7a772cf6bb85fb14cc4afd921e60d04f419 --- /dev/null +++ b/packages/ui-vue/docs/components/section/index.md @@ -0,0 +1 @@ +# Section \ No newline at end of file diff --git a/packages/ui-vue/docs/components/switch/index.md b/packages/ui-vue/docs/components/switch/index.md new file mode 100644 index 0000000000000000000000000000000000000000..b0cbcd593ae939e0a348557c992555e125ae45bc --- /dev/null +++ b/packages/ui-vue/docs/components/switch/index.md @@ -0,0 +1 @@ +# Switch \ No newline at end of file diff --git a/packages/ui-vue/docs/components/tabs/index.md b/packages/ui-vue/docs/components/tabs/index.md new file mode 100644 index 0000000000000000000000000000000000000000..8f62e7757f2384721451c7f31fee1247263f1cce --- /dev/null +++ b/packages/ui-vue/docs/components/tabs/index.md @@ -0,0 +1 @@ +# Tabs \ No newline at end of file diff --git a/packages/ui-vue/docs/components/text/index.md b/packages/ui-vue/docs/components/text/index.md new file mode 100644 index 0000000000000000000000000000000000000000..bf632d97ef6a715f1a469bcab055e65f304f1517 --- /dev/null +++ b/packages/ui-vue/docs/components/text/index.md @@ -0,0 +1 @@ +# Text \ No newline at end of file diff --git a/packages/ui-vue/docs/components/tooltip/index.md b/packages/ui-vue/docs/components/tooltip/index.md new file mode 100644 index 0000000000000000000000000000000000000000..e7f4f198ffa9281142e960deaed8086aa38b0376 --- /dev/null +++ b/packages/ui-vue/docs/components/tooltip/index.md @@ -0,0 +1 @@ +# Tooltip \ No newline at end of file diff --git a/packages/ui-vue/docs/guide/quick-start/index.md b/packages/ui-vue/docs/guide/quick-start/index.md new file mode 100644 index 0000000000000000000000000000000000000000..654e6bdbb31df86bb17dcbd6025e9a4b91359297 --- /dev/null +++ b/packages/ui-vue/docs/guide/quick-start/index.md @@ -0,0 +1,35 @@ +# 快速开始 + +## 开始使用 Farris UI Vue + +### 1. 安装@farris/ui-vue + +``` +npm install @farris/ui-vue +``` + +``` +yarn add @farris/ui-vue +``` + +### 2. 在应用中引入 Farris UI Vue + +在`main.ts`文件中引入`@farris/ui-vue`。 + +```ts +import { createApp } from 'vue'; +import App from './App.vue'; +import Farris from '@farris/ui-vue'; + +createApp(App).use(Farris).mount('#app'); +``` + +### 3. 在应用中使用 Farris UI Vue + +在`App.vue`文件中使用 Farris UI Vue 组件。 + +```vue + +``` diff --git a/packages/ui-vue/docs/index.md b/packages/ui-vue/docs/index.md index f8cdd28b27fd56aec7b83c4b8bfd6500cd074890..4e9cc1f5c4d615c5bf6d4a438977c3797b4804e3 100644 --- a/packages/ui-vue/docs/index.md +++ b/packages/ui-vue/docs/index.md @@ -10,7 +10,7 @@ hero: actions: - theme: brand text: 快速开始 - link: /quick-start/ + link: /guide/quick-start/ - theme: Gitee text: View on Gitee link: https://gitee.com/ubml/farris-vue