shujie-ui 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
- 全平台兼容（微信/支付宝/百度/字节/QQ 小程序 + H5 + App）
|
|
10
10
|
- 按需引入（easycom 自动注册）
|
|
11
11
|
- 单元测试覆盖
|
|
12
|
-
- VitePress
|
|
12
|
+
- 配套 **VitePress 开发者文档**（说明书 + 浏览器里粗看效果；**验收以 UniApp 工程真机/模拟器为准**）
|
|
13
13
|
|
|
14
14
|
## 安装
|
|
15
15
|
|
|
@@ -151,6 +151,24 @@ import { addUnit, debounce, throttle, deepClone, isPhone, isEmail } from 'shujie
|
|
|
151
151
|
import { useVisible, useLoading, useScroll } from 'shujie-ui'
|
|
152
152
|
```
|
|
153
153
|
|
|
154
|
+
## 开发者文档站（非 UniApp 运行时）
|
|
155
|
+
|
|
156
|
+
**shujie-ui 是 UniApp 组件库**：组件模板使用 `view` / `text` 等，面向小程序与 `uni-app` 编译链路；业务里请以 **你自己的 UniApp 项目** 为准做联调与上线。
|
|
157
|
+
|
|
158
|
+
本仓库里的 **VitePress** 只做两件事：写清 **API / 接入方式**（和一般组件库文档一样），以及在 **普通浏览器** 里用近似方式跑一遍 `sj-*`，方便扫一眼样式与交互。**它不是小程序模拟器**，也不能替代微信开发者工具 / HBuilderX 真机预览。
|
|
159
|
+
|
|
160
|
+
```bash
|
|
161
|
+
npm run docs:dev
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
浏览器打开终端里提示的地址（一般为 `http://localhost:5173`）。静态部署：
|
|
165
|
+
|
|
166
|
+
```bash
|
|
167
|
+
npm run docs:build
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
产物在 `docs/.vitepress/dist`，可托管到 Gitee Pages、Nginx 等，给团队当在线说明书。
|
|
171
|
+
|
|
154
172
|
## 链接
|
|
155
173
|
|
|
156
174
|
- [npm 包](https://www.npmjs.com/package/shujie-ui)
|