Skip to content

Commit 027b232

Browse files
committed
docs: add readme for schema and volar
1 parent fb5db9d commit 027b232

File tree

3 files changed

+46
-1
lines changed

3 files changed

+46
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
- [pages-json-schema](./packages/schema/)
1919

20-
`pages.json` 提供 schema
20+
uni-app 的 `pages.json` 提供 schema
2121

2222

2323
## 安装

packages/schema/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# @uni-helper/pages-json-schema
2+
3+
为 uni-app 的 `pages.json` 提供 schema
4+
5+
## 安装
6+
7+
```bash
8+
pnpm add @uni-helper/pages-json-schema
9+
```
10+
11+
## 用法
12+
13+
```js
14+
import PagesSchema from '@uni-helper/pages-json-schema'
15+
16+
console.log(PagesSchema)
17+
18+
// {
19+
// "$ref": "#/definitions/PagesConfig",
20+
// "$schema": "http://json-schema.org/draft-07/schema#",
21+
// "definitions": {...}
22+
// }
23+
```

packages/volar/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# @uni-helper/volar-plugin-uni-pages
2+
3+
`<route>` 块 提供 IntelliSense
4+
5+
## 安装
6+
7+
```bash
8+
pnpm add -D @uni-helper/volar-plugin-uni-pages
9+
```
10+
11+
## 用法
12+
13+
```js
14+
// volar.config.js
15+
const volarPluginUniPages = require('@uni-helper/volar-plugin-uni-pages')
16+
17+
module.exports = {
18+
plugins: [
19+
volarPluginUniPages(),
20+
],
21+
}
22+
```

0 commit comments

Comments
 (0)