diff --git a/packages/devui-vue/docs/.vitepress/config/enSidebar.ts b/packages/devui-vue/docs/.vitepress/config/enSidebar.ts index 00c336177b60d0d33adc44eed92baeb417cf3224..4f814fef10adede3ade044596c936706d44a719c 100644 --- a/packages/devui-vue/docs/.vitepress/config/enSidebar.ts +++ b/packages/devui-vue/docs/.vitepress/config/enSidebar.ts @@ -33,15 +33,15 @@ const enSidebar = { { text: 'Feedback', children: [ - { text: 'Alert', link: '/components/alert/', status: 'completed' }, - { text: 'Drawer', link: '/components/drawer/' }, - { text: 'Loading', link: '/components/loading/', status: 'completed' }, - { text: 'Mention', link: '/components/mention/' }, - { text: 'Modal', link: '/components/modal/' }, - { text: 'Popover', link: '/components/popover/', status: "progress" }, - { text: 'ReadTip', link: '/components/read-tip/' }, - { text: 'Toast', link: '/components/toast/', status: 'completed' }, - { text: 'Tooltip', link: '/components/tooltip/', status: 'completed' }, + { text: 'Alert', link: '/en-US/components/alert/', status: 'completed' }, + { text: 'Drawer', link: '/en-US/components/drawer/' }, + { text: 'Loading', link: '/en-US/components/loading/', status: 'completed' }, + { text: 'Mention', link: '/en-US/components/mention/' }, + { text: 'Modal', link: '/en-US/components/modal/' }, + { text: 'Popover', link: '/en-US/components/popover/', status: "progress" }, + { text: 'ReadTip', link: '/en-US/components/read-tip/' }, + { text: 'Toast', link: '/en-US/components/toast/', status: 'completed' }, + { text: 'Tooltip', link: '/en-US/components/tooltip/', status: 'completed' }, ] }, { diff --git a/packages/devui-vue/docs/en-US/index.md b/packages/devui-vue/docs/en-US/index.md new file mode 100644 index 0000000000000000000000000000000000000000..8c2877b1eb7993c85799182afe81cb37dbb29b6e --- /dev/null +++ b/packages/devui-vue/docs/en-US/index.md @@ -0,0 +1,78 @@ +# Quick Start + +Guide you how to use DevUI in your project + +### Vue version + +Vue version currently supported ^3.0.0 + +### 1. Create a project + +It is recommended to use @vite/cli to create your project + +```shell +yarn create vite my-vue-app --template vue-ts +``` + +### 2. Install + +Go to your project folder and use yarn to install DevUI + +```shell +yarn add vue-devui + +# Optional, font icon library, some demos rely on this font library +# yarn add @devui-design/icons +# main.ts file introduction +# import '@devui-design/icons/icomoon/devui-icon.css' +``` + +### 3. Import modules and styles + +main.ts + +```js +import DevUI from 'vue-devui' +import 'vue-devui/style.css' + +createApp(App).use(DevUI).mount('#app') +``` +```js +// On-demand introduction +// main.ts file +import { createApp } from 'vue' +import App from './App.vue' + +// Step 1: Introduce a single component +import { Button } from 'vue-devui' +// or import Button from 'vue-devui/button' +// Step 2: Introduce component style +// 方式一:Manually import component styles +import 'vue-devui/button/style.css' + +// 方式二:Automatically introduce components on demand +// vite.config.ts file +// import styleImport from 'vite-plugin-style-import' +// plugins: [ +// vue(), +// styleImport({ +// libs: [ +// { +// libraryName: 'vue-devui', +// esModule: true, +// resolveStyle: (name) => `vue-devui/${name}/style`, +// }, +// ], +// }) +// ] + +createApp(App) +.use(Button) // Step 3: Use component +.mount('#app') +``` + +### 4. Start development and debugging + +```shell +yarn dev +``` \ No newline at end of file