From 2541706ac3fbb4499aa5df5eed63adc884670261 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E4=BC=A0=E9=BE=99?= Date: Sun, 10 Apr 2022 14:06:06 +0800 Subject: [PATCH] docs: update readme --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2b43fec..204d872 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,16 @@ -## VUE NAIVE ADMIN +

+ + Vue Naive Admin Logo + +

+

+ + + + + +

+ ### 简介 @@ -19,20 +31,24 @@ - 🍇 集成 unocss,antfu 大神开源的原子化 css 解决方案,非常轻量,目前我是自己写 scss 样式搭配着 unocss 使用的 - 🍍 集成 Pinia,Vuex 的替代方案,轻量、简单、易用(尤大已表示不会有Vuex5,或者说pinia就是Vuex5) - 📦 集成 Vite 自动导入插件unplugin-vue-components,解放双手,开发效率直接起飞 +- 🤹 集成 unplugin-icons插件,优雅使用iconify图标 - 🍏 二次封装 Axios,支持多 axios 实例,支持线上环境免重新打包修改 baseURL - 🍌 二次封装全局 Dialog、Message、LoadingBar 组件 - 🍋 二次封装 localStorage 和 sessionStorage,支持设置过期时间 -## 预览 +### 预览 [template.qszone.com](https://template.qszone.com) -## 文档 +[github pages](https://zclzone.github.io/vue-naive-admin) + +### 文档 [Vue Naive Admin Docs](https://zclzone.github.io/vue-naive-admin-docs) + [羽雀文档:Vue Naive Admin](https://www.yuque.com/qszone/vue-naive-admin) -## 构建步骤 +### 构建 ```shell # 推荐配置git autocrlf 为 false(本项目规范使用lf换行符,此配置是为防止git自动将源文件转换为crlf) @@ -52,7 +68,7 @@ pnpm i # 或者 npm i npm run dev ``` -## 发布 +### 发布 ```shell # 构建测试环境 @@ -65,7 +81,7 @@ npm run build:github npm run build ``` -## 其他指令 +### 其他指令 ```shell # eslint代码格式检查 @@ -78,7 +94,9 @@ npm run lint:fix npm run preview ``` -## Git 提交规范 +### 规范 + +#### git commit 规范 - `feat` 增加新功能 - `fix` 修复问题/BUG @@ -94,3 +112,4 @@ npm run preview - `types` 类型定义文件更改 - `wip` 开发中 - `mod` 不确定分类的修改 +