Skip to content

Commit

Permalink
docs:README
Browse files Browse the repository at this point in the history
  • Loading branch information
EricWXY committed Apr 1, 2024
1 parent ab452e4 commit 00d32b2
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 26 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Eric-UI

Vue3 + TS 高仿 ElementPlus 打造自己的组件库

一款功能全面、易用性强、文档丰富的UI组件库,完美兼容Element Plus,为开发者提供高效的界面构建解决方案。

## 特性

### 功能覆盖和兼容性
- **广泛兼容**:本组件库能够广泛覆盖Element Plus的所有功能,确保无缝迁移。
- **API一致性**:与Element Plus的API保持高度兼容,提供相同的功能和使用体验。

### 易用性和简化开发流程
- **简洁API**:提供简洁明了的API和组件结构,助力开发者快速上手。
- **高效构建**:优化组件设计,减少开发时间和工作量,提升开发效率。
- **多范式兼容**:部分组件支持多种开发范式,满足不同开发者的需求。

### 文档和示例丰富
- **详细文档**:在线文档包含对每个组件的详尽描述,帮助用户深入理解。
- **实用示例**:提供清晰的示例代码和演示,加速用户的学习和应用过程。
- **易于理解**:通过解释和演示,帮助用户掌握组件的用途、属性和事件。

## 开始使用

- 访问 [Eric-UI (ericwxy.github.io)](https://ericwxy.github.io/eric-ui/#/) 了解更多信息。

## 贡献指南

我们欢迎并鼓励社区成员为组件库贡献力量。无论是报告问题、提交改进建议还是分享使用经验,都是对我们的宝贵支持。
25 changes: 0 additions & 25 deletions packages/docs/.vitepress/theme/custom.css

This file was deleted.

1 change: 0 additions & 1 deletion packages/docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import { type App } from "vue";
import { ElementPlusContainer } from "@vitepress-demo-preview/component";

import "@vitepress-demo-preview/component/dist/style.css";
import "./custom.css";

export default {
...DefaultTheme,
Expand Down

0 comments on commit 00d32b2

Please sign in to comment.