Skip to content

Commit b3de549

Browse files
committed
docs: upgrade
1 parent 767394b commit b3de549

5 files changed

Lines changed: 170 additions & 15 deletions

File tree

website/blog/2025/8/v4.2-release.mdx

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
并借助 `uni-app x` 的能力,把 `tailwindcss` 原子化样式方案,同时带入到 `Web`,`小程序`, `安卓`,`IOS`, `鸿蒙` 等多端开发中!
1010

11-
## 如何使用
11+
## 快速集成
1212

1313
### 0. 创建项目
1414

@@ -20,7 +20,7 @@ npm init -y
2020

2121
初始化一个 `package.json` 文件 (当然你也可以手动创建)
2222

23-
### 1. [安装并引入 tailwindcss3](/docs/quick-start/install)
23+
### 1. 安装并引入 tailwindcss3
2424

2525

2626
```bash npm2yarn
@@ -43,7 +43,7 @@ npx tailwindcss init
4343
</style>
4444
```
4545

46-
### 2. [安装 weapp-tailwindcss](/docs/quick-start/this-plugin)
46+
### 2. 安装 weapp-tailwindcss
4747

4848
在项目目录下,执行:
4949

@@ -62,7 +62,7 @@ npm i -D weapp-tailwindcss
6262

6363
想知道原因的同学可以查看 [**这个链接**](https://tw.icebreaker.top/docs/quick-start/this-plugin)
6464

65-
### 3. [uni-app-x 注册 weapp-tailwindcss](/docs/quick-start/frameworks/uni-app-x)
65+
### 3. uni-app-x 注册 weapp-tailwindcss
6666

6767
#### 0. 创建工具类
6868

@@ -118,7 +118,7 @@ export default defineConfig({
118118

119119
#### 2. 更改 tailwindcss 配置
120120

121-
使用绝对路径,包括所有的提取文件
121+
你需要在 `tailwind.config.js``content` 配置中,使用绝对路径去包括所有的提取文件
122122

123123
```js title="tailwind.config.js"
124124
const { r } = require('./shared')
@@ -136,13 +136,13 @@ module.exports = {
136136

137137
```
138138

139-
假如你需要从更多的目录中提取 `CSS Token`,你需要添加更多的 `glob` 表达式在 `content` 配置中。
139+
> 假如你需要从更多的目录/文件中提取 `CSS Token`,你需要添加更多的 `glob` 表达式在 `content` 配置中。
140140
141141
---
142142

143-
在完成这 3 步之后`uni-app x` 就集成 `tailwindcss` 原子化样式解决方案。
143+
在完成这些步骤之后`uni-app x` 就集成 `tailwindcss` 原子化样式解决方案。
144144

145-
## 如何开发
145+
## 如何运行
146146

147147
目前 `uni-app x` 并没有提供任何 `cli` 的方式去使用它,所以目前我们使用 `Hbuilderx` 去进行开发和构建的。
148148

@@ -201,14 +201,16 @@ IOS 模拟器,需要你有 Mac 才能运行,IOS 调试需要你有苹果手
201201

202202
当然,你直接全局修改你的 `vscode Tailwindcss` 插件配置肯定也是可以的。
203203

204+
## 尾言
205+
206+
`uni-app x` 是一个 **庞大的工程**, `DCloud` 团队能做出这样的技术解决方案,令人倾佩。
207+
204208
## 配置好的模板
205209

206210
https://github.com/icebreaker-template/uni-app-x-hbuilderx
207211

208212
使用方式见这个项目中的 `README.md`
209213

210-
## 结尾
211-
212214
## 参考文档
213215

214216
[uni-app x 官方文档](https://doc.dcloud.net.cn/uni-app-x/)

website/docs/uni-app-x/_shared.mdx

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
## 如何使用
2+
3+
### 0. 创建项目
4+
5+
使用最新版本 `Hbuilderx` 创建一个 `uni-app x` 项目,然后执行
6+
7+
```bash npm2yarn
8+
npm init -y
9+
```
10+
11+
初始化一个 `package.json` 文件 (当然你也可以手动创建)
12+
13+
### 1. [安装并引入 tailwindcss3](/docs/quick-start/install)
14+
15+
16+
```bash npm2yarn
17+
# 安装 tailwindcss@3 版本的依赖
18+
npm i -D tailwindcss@3 postcss autoprefixer
19+
```
20+
21+
```bash npm2yarn
22+
# 初始化一个 tailwind.config.js 文件
23+
npx tailwindcss init
24+
```
25+
26+
然后,在你的根目录中的 `App.uvue` 中引入 `tailwindcss` 使它在应用全局生效
27+
28+
```html title="App.uvue"
29+
<style>
30+
@tailwind base;
31+
@tailwind components;
32+
@tailwind utilities;
33+
</style>
34+
```
35+
36+
### 2. [安装 weapp-tailwindcss](/docs/quick-start/this-plugin)
37+
38+
在项目目录下,执行:
39+
40+
```bash npm2yarn
41+
npm i -D weapp-tailwindcss
42+
```
43+
44+
然后把下列脚本,添加进你的 `package.json``scripts` 字段里:
45+
46+
```json title="package.json"
47+
"scripts": {
48+
// highlight-next-line
49+
"postinstall": "weapp-tw patch"
50+
}
51+
```
52+
53+
想知道原因的同学可以查看 [**这个链接**](https://tw.icebreaker.top/docs/quick-start/this-plugin)
54+
55+
### 3. [uni-app-x 注册 weapp-tailwindcss](/docs/quick-start/frameworks/uni-app-x)
56+
57+
#### 0. 创建工具类
58+
59+
在项目中创建 `shared.js` 文件,用于存放一些工具函数:
60+
61+
```js title="shared.js"
62+
const path = require('node:path')
63+
64+
function r(...args) {
65+
return path.resolve(__dirname, ...args)
66+
}
67+
68+
module.exports = {
69+
r,
70+
}
71+
```
72+
73+
#### 1. 注册插件
74+
75+
创建 `vite.config.ts` 文件,注册插件:
76+
77+
> 这里特别注意 `uniAppX` 是从 `weapp-tailwindcss/presets` 这个预设中导出的
78+
79+
```js title="vite.config.ts"
80+
import { defineConfig } from 'vite';
81+
import uni from '@dcloudio/vite-plugin-uni';
82+
import { UnifiedViteWeappTailwindcssPlugin } from 'weapp-tailwindcss/vite'
83+
import { r } from './shared'
84+
import { uniAppX } from 'weapp-tailwindcss/presets'
85+
import tailwindcss from 'tailwindcss'
86+
87+
export default defineConfig({
88+
plugins: [
89+
uni(),
90+
UnifiedViteWeappTailwindcssPlugin(
91+
uniAppX({
92+
base: __dirname,
93+
rem2rpx: true,
94+
}),
95+
),
96+
],
97+
css: {
98+
postcss: {
99+
plugins: [
100+
tailwindcss({
101+
config: r('./tailwind.config.js'),
102+
}),
103+
]
104+
}
105+
}
106+
});
107+
```
108+
109+
#### 2. 更改 tailwindcss 配置
110+
111+
使用绝对路径,包括所有的提取文件
112+
113+
```js title="tailwind.config.js"
114+
const { r } = require('./shared')
115+
116+
/** @type {import('tailwindcss').Config} */
117+
module.exports = {
118+
content: [
119+
r('./pages/**/*.{uts,uvue}'),
120+
r('./components/**/*.{uts,uvue}')
121+
],
122+
corePlugins: {
123+
preflight: false,
124+
},
125+
}
126+
127+
```
128+
129+
假如你需要从更多的目录中提取 `CSS Token`,你需要添加更多的 `glob` 表达式在 `content` 配置中。
130+
131+
---
132+
133+
在完成这 3 步之后, `uni-app x` 就集成 `tailwindcss` 原子化样式解决方案。

website/docs/uni-app-x/index.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,16 @@ import TailwindcssLogo from '../../../assets/logo.png'
2828

2929
## 如何使用
3030

31-
在使用 `Hbuilderx` 创建一个 `uni-app x` 项目后,可以遵循:
31+
### [🚀详见快速集成](/docs/uni-app-x/install)
32+
33+
{/* 在使用 `Hbuilderx` 创建一个 `uni-app x` 项目后,可以遵循:
3234
3335
### 1. [安装与配置 tailwindcss3](/docs/quick-start/install)
3436
### 2. [安装 weapp-tailwindcss](/docs/quick-start/this-plugin)
3537
### 3. [uni-app-x 注册 weapp-tailwindcss](/docs/quick-start/frameworks/uni-app-x)
36-
### 4. [rem 转 rpx (或 px)](/docs/quick-start/rem2rpx)
38+
### 4. [rem 转 rpx (或 px)](/docs/quick-start/rem2rpx) */}
3739

38-
这套的流程,集成 `tailwindcss` 原子化样式解决方案。
40+
{/* 这套的流程,集成 `tailwindcss` 原子化样式解决方案。 */}
3941

4042
## 如何开发
4143

website/docs/uni-app-x/install.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import Shared from './_shared.mdx'
2+
3+
# 快速集成
4+
5+
<Shared/>

website/sidebars.ts

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,10 +134,23 @@ const tutorialSidebar: SidebarConfig = [
134134
},
135135
],
136136
},
137+
137138
{
138-
type: 'doc',
139-
id: 'uni-app-x/index',
139+
type: 'category',
140140
label: '🔥uni-app x 专题',
141+
collapsed: false,
142+
items: [
143+
{
144+
type: 'doc',
145+
id: 'uni-app-x/index',
146+
label: '前言',
147+
},
148+
{
149+
type: 'doc',
150+
id: 'uni-app-x/install',
151+
label: '快速集成',
152+
},
153+
],
141154
},
142155
{
143156
type: 'doc',

0 commit comments

Comments
 (0)