Skip to content

Commit 4a01d28

Browse files
watsonhaw5566watsonhaw5566
andauthored
Update docs (#156)
* docs: 更新 rsmax 安装说明 * docs: 移除 v1 文档 --------- Co-authored-by: watsonhaw5566 <348748267@qq.com>
1 parent 8be6941 commit 4a01d28

43 files changed

Lines changed: 17 additions & 3172 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export default function Counter() {
2929
## 快速开始
3030

3131
```bash
32-
pnpm add rsmax
32+
pnpm add -D rsmax
3333
rsmax dev src -o dist
3434
```
3535

@@ -42,8 +42,6 @@ pnpm docs:dev # 本地预览
4242
pnpm docs:build # 构建文档
4343
```
4444

45-
文档内含 v2(当前版本)与 v1(旧版)两套内容,可在导航栏右上角切换。
46-
4745
## License
4846

4947
MIT

‎docs/.vitepress/config.js‎

Lines changed: 1 addition & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { defineConfig } from 'vitepress';
22

33
// ============================================================
4-
// v2(当前版本)侧边栏
4+
// 侧边栏
55
// ============================================================
66
const guideSidebar = [
77
{
@@ -39,111 +39,6 @@ const guideSidebar = [
3939
},
4040
];
4141

42-
// ============================================================
43-
// v1(旧版)侧边栏
44-
// ============================================================
45-
const v1GuideSidebar = [
46-
{
47-
text: '开始',
48-
collapsed: false,
49-
items: [
50-
{ text: '快速上手', link: '/v1/guide/quick-start' },
51-
{ text: '常见问题', link: '/v1/faq' },
52-
],
53-
},
54-
{
55-
text: '基础指南',
56-
collapsed: false,
57-
items: [
58-
{ text: 'CLI 命令行', link: '/v1/guide/basic/cli' },
59-
{ text: 'React', link: '/v1/guide/basic/react' },
60-
{ text: 'public 目录', link: '/v1/guide/basic/public' },
61-
{ text: '调试工具', link: '/v1/guide/basic/devtools' },
62-
{ text: '错误处理', link: '/v1/guide/basic/error-handling' },
63-
{ text: '小程序自定义组件', link: '/v1/guide/basic/custom-component' },
64-
{ text: '使用小程序插件', link: '/v1/guide/basic/plugin' },
65-
],
66-
},
67-
{
68-
text: '进阶指南',
69-
collapsed: false,
70-
items: [
71-
{ text: '混合开发', link: '/v1/guide/advanced/hybrid' },
72-
{ text: '性能优化', link: '/v1/guide/advanced/performance' },
73-
{ text: '使用插件', link: '/v1/guide/advanced/plugin' },
74-
{ text: '状态共享', link: '/v1/guide/advanced/sharing-state' },
75-
{ text: 'TypeScript 支持', link: '/v1/guide/advanced/typescript' },
76-
],
77-
},
78-
{
79-
text: '框架',
80-
collapsed: false,
81-
items: [
82-
{ text: 'App', link: '/v1/guide/framework/app' },
83-
{ text: '页面', link: '/v1/guide/framework/page' },
84-
{ text: '组件', link: '/v1/guide/framework/component' },
85-
{ text: '事件', link: '/v1/guide/framework/event' },
86-
{ text: 'API', link: '/v1/guide/framework/api' },
87-
{ text: '样式', link: '/v1/guide/framework/style' },
88-
],
89-
},
90-
{
91-
text: '跨平台开发',
92-
collapsed: false,
93-
items: [
94-
{ text: 'Rsmax One', link: '/v1/guide/one/' },
95-
{ text: 'Web 同构', link: '/v1/guide/one/web' },
96-
],
97-
},
98-
{
99-
text: '配置',
100-
collapsed: false,
101-
items: [
102-
{ text: 'Rsmax 配置', link: '/v1/guide/config/rsmax' },
103-
{ text: '环境变量', link: '/v1/guide/config/environment-variables' },
104-
{ text: 'PostCSS 配置', link: '/v1/guide/config/postcss' },
105-
],
106-
},
107-
{
108-
text: '其他',
109-
collapsed: false,
110-
items: [
111-
{ text: '小程序插件开发', link: '/v1/guide/writing-mini-plugins' },
112-
{ text: '实现原理', link: '/v1/guide/implementation-notes' },
113-
],
114-
},
115-
];
116-
117-
const v1ApiSidebar = [
118-
{
119-
text: 'API',
120-
collapsed: false,
121-
items: [
122-
{ text: 'rsmax', link: '/v1/api/rsmax' },
123-
{ text: 'rsmax / build', link: '/v1/api/rsmax-build' },
124-
{ text: 'rsmax / macro', link: '/v1/api/rsmax-macro' },
125-
],
126-
},
127-
{
128-
text: 'rsmax / one',
129-
collapsed: false,
130-
items: [
131-
{ text: 'API', link: '/v1/api/rsmax-one/api' },
132-
{ text: '组件', link: '/v1/api/rsmax-one/components' },
133-
{ text: '事件', link: '/v1/api/rsmax-one/event' },
134-
{ text: '生命周期', link: '/v1/api/rsmax-one/lifecycle' },
135-
],
136-
},
137-
{
138-
text: 'rsmax / [平台]',
139-
collapsed: false,
140-
items: [
141-
{ text: 'API', link: '/v1/api/rsmax-platform/api' },
142-
{ text: '组件', link: '/v1/api/rsmax-platform/component' },
143-
],
144-
},
145-
];
146-
14742
export default defineConfig({
14843
lang: 'zh-CN',
14944
title: 'Rsmax',
@@ -156,19 +51,9 @@ export default defineConfig({
15651

15752
nav: [
15853
{ text: '指南', link: '/guide/introduction', activeMatch: '/guide/' },
159-
{
160-
text: 'v2.x',
161-
items: [
162-
{ text: 'v2.x', link: '/' },
163-
{ text: 'v1.x', link: '/v1/' },
164-
],
165-
},
16654
],
16755

168-
// 更具体的前缀需放在前面
16956
sidebar: {
170-
'/v1/api/': v1ApiSidebar,
171-
'/v1/': v1GuideSidebar,
17257
'/guide/': guideSidebar,
17358
},
17459

‎docs/guide/getting-started.md‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,16 @@
88

99
## 安装
1010

11-
在你的小程序项目中安装 `rsmax`:
11+
在你的小程序项目中安装 `rsmax`(**请安装到 `devDependencies`**):
1212

1313
```bash
14-
pnpm add rsmax
14+
pnpm add -D rsmax
1515
```
1616

17+
::: warning 为什么必须是 devDependencies
18+
rsmax 是编译期工具链,小程序运行时并不依赖它。微信开发者工具的「构建 npm」只会扫描 `dependencies`,若把 rsmax 装入其中,工具会连带解析它的 Node 侧依赖(如 `@parcel/watcher`、`@babel/*`),这些包含工具无法解析的语法,构建会报 `parse js file ... failed: Unexpected token` 之类的错误。
19+
:::
20+
1721
## 项目结构
1822

1923
```
@@ -106,4 +110,11 @@ npx rsmax build src -o dist
106110

107111
## 使用 npm 包
108112

109-
首次使用第三方 npm 包后,需在微信开发者工具中执行 **工具 → 构建 npm**。构建产物 `miniprogram_npm` 目录会被 rsmax 自动保留,无需重复构建。详见 [CLI 命令](./cli)。
113+
依赖按用途安装到不同位置:
114+
115+
| 依赖类型 | 安装位置 | 示例 |
116+
|---------|---------|------|
117+
| 编译期工具链 | `devDependencies`(`pnpm add -D`) | `rsmax` |
118+
| 小程序运行时使用的包 | `dependencies`(`pnpm add`) | `@vant/weapp`、`tdesign-miniprogram`、`dayjs` |
119+
120+
「构建 npm」只处理 `dependencies` 中的包:首次安装运行时 npm 包后,需在微信开发者工具中执行 **工具 → 构建 npm**。构建产物 `miniprogram_npm` 目录会被 rsmax 自动保留,无需重复构建。详见 [CLI 命令](./cli)。

‎docs/guide/ui-libraries.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
| TDesign MiniProgram | `tdesign-miniprogram` | `t-` | `t-button` → `tdesign-miniprogram/button/button` |
1111
| Ant Design Mini | `antd-mini` | `ant-` | `ant-button` → `antd-mini/Button/index` |
1212

13-
安装后直接使用:
13+
安装后直接使用(UI 组件库属于小程序运行时依赖,请安装到 `dependencies`,**不要加 `-D`**,否则「构建 npm」扫描不到):
1414

1515
```bash
1616
pnpm add @vant/weapp

‎docs/public/v1/logo.png‎

-18.1 KB
Binary file not shown.

‎docs/public/v1/og-image.png‎

-32.2 KB
Binary file not shown.

‎docs/v1/api/rsmax-build.md‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎docs/v1/api/rsmax-macro.md‎

Lines changed: 0 additions & 122 deletions
This file was deleted.

0 commit comments

Comments
 (0)