Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
novlan1 committed Jul 8, 2024
1 parent 1b38038 commit 8455756
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 10 deletions.
2 changes: 1 addition & 1 deletion packages/press-ui/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ npm run act:replace:class

### 4.4. 项目依赖关系

Press UI 底层依赖 `t-comm``uni-plugin-light` 等库。
Press UI 底层依赖 `t-comm``plugin-light` 等库。

<img src="https://mike-1255355338.cos.ap-guangzhou.myqcloud.com/article/2024/6/own_mike_bbf5d09066a8980616.gif" width="500" />

Expand Down
2 changes: 1 addition & 1 deletion packages/press-ui/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ npm run act:replace:class

### 4.4. 项目依赖关系

Press UI 底层依赖 `t-comm``uni-plugin-light` 等库。
Press UI 底层依赖 `t-comm``plugin-light` 等库。

<img src="https://mike-1255355338.cos.ap-guangzhou.myqcloud.com/article/2024/6/own_mike_bbf5d09066a8980616.gif" width="500" />

Expand Down
14 changes: 6 additions & 8 deletions packages/press-ui/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ module.exports = {
1. 安装 npm 包:

```bash
npm i uni-plugin-light -D
npm i plugin-light -D
```

2.`vue.config.js` 中添加如下设置:

```js
const IF_DEF_LOADER = 'uni-plugin-light/lib/loader/ifdef-loader';
const IF_DEF_LOADER = 'plugin-light/lib/loader/ifdef-loader';

module.export = {
chainWebpack(config) {
Expand Down Expand Up @@ -163,13 +163,11 @@ export default {

## 4. 普通 Vue3 项目

Vite 中不支持 `transpileDependencies` 选项,`Press UI` 提供了两种方案
Vite 中不支持 `transpileDependencies` 选项,`Press UI` 提供了使用方案

1. 直接使用编译后的包 `press-ui-vue3`
2. 拷贝 `node_modules/press-ui` 的代码到 `src` 某目录下, 并配置 `alias` 指向该目录
1. 脚本拷贝 `node_modules/press-ui` 的代码到 `src` 某目录下
2. 配置 `alias` 指向该目录

第1种方式的好处是,对于只用于 `Vue3` 项目的开发者来说,使用成本低,心智负担小。缺点是使用了 `Press UI` 的组件(比如 `Press Plus` 中的组件),如果也想兼容 `Vue2``Vue3` 的话,需要添加条件编译,另外,组件库更新频繁的也比较麻烦。

第2种方式符合 `transpileDependencies` 的本意,即然作为源码来编译,那就直接放到源码位置即可。这种处理方式的好处是,不用处理之前的组件,比如 `Press Plus` 组件。
这种方式符合 `transpileDependencies` 的本意,既然作为源码来编译,那就直接放到源码位置即可。

这里提供了一个 [Vite 插件](https://novlan1.github.io/uni-plugin-light/zh/vite/alias-for-library.html),可以自动化的进行拷贝。

0 comments on commit 8455756

Please sign in to comment.