本地开发

docs文档结构目录

├─ examples                 # VPDemo组件自动解析此文件夹下的所有.vue文件
├─ components               # .md文件
├─ guide                    # 指南.md文件
├─ public                   # 静态资源文件
│─ mock                     # mock数据配置
├─ .vitepress
│  ├─ config                # 插件配置
|  │  ├─ head.ts            # 网站head 配置，目前配置了favicon.icon
|  │  ├─ basic.ts           # 基础配置
|  │  ├─ plugins.ts         # 插件配置
|  │  └─ themeConfig        # 自定义
|  │     ├─ basic           # 自定义 基础配置
|  │     ├─ footer          # 自定义 页脚配置
|  │     ├─ index           # 当前文件夹出口文件
|  │     ├─ nav             # nav导航
|  │     ├─ search          # 头部搜索配置
|  │     ├─ sidebar         # 侧边栏sidebar配置
|  │     └─ socialLinks     # 页面头部右上角配置 仓库地址邮箱
│  ├─ theme                 # 主题配置
│  ├─ utils                 # 文档展开隐藏代码高亮
│  ├─ vitepress
|  │  ├─ vp-demo            # VPDemo组件源码
|  │  ├─ style              # VPDemo组件样式
|  │  └─ index.ts           # 暴露VPDemo组件
│  └─ config.ts             # vitepress配置文件
├─ index.md                 # 文档home页面
├─ tsconfig.json            # typescript 全局配置
└─ vite.config.ts           # vite 全局配置文件（支持tsx）

启动项目

使用命令

pnpm i

网站文档预览

使用命令

pnpm docs:dev

该项目将启动网站，网站内你可以预览全部现有组件，及文档

本地开发预览

1. 初始化一个vue3 项目 并引入element-plus,相关文档，请查看element-plus相关文档
2. 安装ys-inside-ui

pnpm install */项目存放路径/*/ys-ui

3. 引入YS-UI 参考快速开始文档；

4. 启动自己项目

Git 提交规范（PR提交规范）

• ci: ci 配置文件和脚本的变动;
• chore: 构建系统或辅助工具的变动;
• fix: 代码 BUG 修复;
• feat: 新功能;
• perf: 性能优化和提升;
• refactor: 仅仅是代码变动，既不是修复 BUG 也不是引入新功能;
• style: 代码格式调整，可能是空格、分号、缩进等等;
• docs: 文档变动;
• test: 补充缺失的测试用例或者修正现有的测试用例;
• revert: 回滚操作;
• add: 增加代码逻辑;
• del: 删除功能;
• update: 更新功能;
• build: 构造工具或者相关依赖的改动;