From 50d2922e17f1ceb0fa7b5e82600abc49be939991 Mon Sep 17 00:00:00 2001 From: CharleeWa <18888351756@163.com> Date: Tue, 23 Jul 2024 17:46:18 +0800 Subject: [PATCH] docs: add vue3-vant-mobile intro --- .vitepress/config.ts | 10 ++++---- .vscode/settings.json | 9 +++++++ vue3-vant-mobile/index.md | 51 +++++++++++++++++++++++++++++++++++++-- 3 files changed, 63 insertions(+), 7 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 915ba84..aa80ce0 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -5,23 +5,23 @@ const Guides: DefaultTheme.NavItemWithLink[] = [ ] const vue3VantMobile: DefaultTheme.NavItemWithLink[] = [ - { text: '概述', link: '/vue3-vant-mobile/' }, + { text: '介绍', link: '/vue3-vant-mobile/' }, ] const vue3VarletMobile: DefaultTheme.NavItemWithLink[] = [ - { text: '概述', link: '/vue3-varlet-mobile/' }, + { text: '介绍', link: '/vue3-varlet-mobile/' }, ] const nuxt3VantMobile: DefaultTheme.NavItemWithLink[] = [ - { text: '概述', link: '/nuxt3-vant-mobile/' }, + { text: '介绍', link: '/nuxt3-vant-mobile/' }, ] const vue3ElementAdmin: DefaultTheme.NavItemWithLink[] = [ - { text: '概述', link: '/vue3-element-admin/' }, + { text: '介绍', link: '/vue3-element-admin/' }, ] const vue3AntdvMobile: DefaultTheme.NavItemWithLink[] = [ - { text: '概述', link: '/vue3-antdv-admin/' }, + { text: '介绍', link: '/vue3-antdv-admin/' }, ] const Nav: DefaultTheme.NavItem[] = [ diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..f01acfa --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,9 @@ +{ + // Markdownlint rules + "markdownlint.config": { + "default": true, + "MD025": false, + "MD001": false, + "MD033": false + } +} diff --git a/vue3-vant-mobile/index.md b/vue3-vant-mobile/index.md index 5b467cb..14ef373 100644 --- a/vue3-vant-mobile/index.md +++ b/vue3-vant-mobile/index.md @@ -1,3 +1,50 @@ -# vue3 vant mobile +--- +title: 介绍 +description: 一个基于 Vue 3 生态系统的移动 web 应用模板,帮助你快速完成业务开发 +--- -> ✍ 还未编写,敬请期待 +# 介绍 + +[vue3-vant-mobile](https://github.com/easy-temps/vue3-vant-mobile) 是一款开源免费且开箱即用的移动模版,完全采用 `ECMAScript` 模块(`ESM`)规范来编写和组织代码,使用了最新的 `Vue3`、`Vite`、`Vant`、`TypeScript`、`Pinia`、`Unocss` 等主流技术开发。我们还提供了业务当中常用的组件,例如:`Dark Mode`、`i18n`、`Mock`、`ECharts`、`Pinia` 持久化、`KeepAlive` 等示例。总之,开发者借助这个模板,可以继续向上构建自己的业务场景,快速完成开发工作。 + +## 在线预览 + +:point_right: [Live Demo](https://vue3-vant-mobile.netlify.app/) + +[![Netlify Status](https://api.netlify.com/api/v1/badges/e6828bd2-2904-4c3e-a67c-b97d32aa1275/deploy-status)](https://app.netlify.com/sites/vue3-vant-mobile/deploys) + +## 预配置 + +### UI 框架 + +- [UnoCSS](https://github.com/antfu/unocss) - 高性能且极具灵活性的即时原子化 CSS 引擎 + - [@unocss/preset-rem-to-px](https://github.com/unocss/unocss/tree/main/packages/preset-rem-to-px) - 将所有实用程序的 rem 转换为 px + - [eslint-plugin-unocss](https://github.com/devunt/eslint-plugin-unocss) - Unocss 的 ESLint 插件 +- [Vant](https://github.com/youzan/vant) - 移动端 Vue 组件库 + - [vant-touch-emulator](https://github.com/youzan/vant/tree/main/packages/vant-touch-emulator) - 在桌面端上模拟移动端 touch 事件 + - [vant-use](https://github.com/youzan/vant/tree/main/packages/vant-use) - Vant 内置的组合式 API + +### 插件 + +- [Vue Router](https://github.com/vuejs/router) + - [unplugin-vue-router](https://github.com/posva/unplugin-vue-router) - 以文件系统为基础的路由 +- [Pinia](https://pinia.vuejs.org) - 直接的, 类型安全的, 使用 Composition API 的轻便灵活的 Vue 状态管理库 + - [pinia-plugin-persistedstate](https://github.com/prazdevs/pinia-plugin-persistedstate) - 适用于 Pinia 的持久化存储插件 +- [Vue I18n](https://github.com/intlify/vue-i18n-next) - 国际化 + - [unplugin-vue-i18n](https://github.com/intlify/bundle-tools/tree/main/packages/unplugin-vue-i18n) - Vue I18n 的 Vite 插件 +- [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) - 自动加载组件 +- [unplugin-auto-import](https://github.com/antfu/unplugin-auto-import) - 直接使用 Composition API 等,无需导入 +- [vite-plugin-vconsole](https://github.com/vadxq/vite-plugin-vconsole) - vConsole 的 vite 插件 +- [vite-plugin-mock-dev-server](https://github.com/pengzhanbo/vite-plugin-mock-dev-server) - vite mock 开发服务(mock-dev-server)插件 +- [postcss-mobile-forever](https://github.com/wswmsword/postcss-mobile-forever) - 一款 PostCSS 插件,将固定尺寸的移动端视图转为具有最大宽度的可伸缩的移动端视图 +- [vite-plugin-vue-devtools](https://github.com/vuejs/devtools-next) - 旨在增强Vue开发者体验的Vite插件 +- [vueuse](https://github.com/antfu/vueuse) - 实用的 Composition API 工具合集 +- [@unhead/vue](https://github.com/unjs/unhead) - 响应式地操作文档头信息 +- [vite-plugin-pwa](https://github.com/antfu/vite-plugin-pwa) - PWA +- [vite-plugin-sitemap](https://github.com/jbaubree/vite-plugin-sitemap) - sitemap 和 robots 生成器 + +## 问题反馈 + +我们推荐使用 [议题](https://github.com/easy-temps/vue3-vant-mobile/issues) 来反馈问题, 或者您也可以通过微信群联系我们。 + +community