Skip to content

M
Mister Hope.Github.Io

前端资源 / Mister Hope.Github.Io

通知 1
Star 0
Fork 0
M
Mister Hope.Github.Io

前往新版Gitcode，体验更适合开发者的 AI 搜索 >>

提交 c08cef17 编写于 作者: M Mr.Hope
浏览文件
操作

feat: update miniapp guide

上级 f25d41b8
展开全部 隐藏空白更改
内联 并排
Showing with 441 addition and 223 deletion
src/code/mini-app/framework/tag-list.md
浏览文件 @ c08cef17
...@@ -4,7 +4,7 @@ icon: list ...@@ -4,7 +4,7 @@ icon: list
category: 小程序 category: 小程序
--- ---
![版本: V4](https://img.shields.io/badge/版本-V4-blue.svg?style=for-the-badge) ![版本: V5](https://img.shields.io/badge/版本-V5-blue.svg?style=for-the-badge)
## 总体结构 ## 总体结构
...@@ -65,73 +65,84 @@ category: 小程序 ...@@ -65,73 +65,84 @@ category: 小程序
文字块，可设置标题与样式 文字块，可设置标题与样式
| 参数 | 必填 | 值类型 | 内容 | 备注 | | 参数 | 必填 | 值类型 | 内容 | 备注 |
| ------- | :--: | :-----------------------------------------------: | ------------ | --------------------------------------------------------------- | | ------- | :--: | :-----------------------------------------------: | ------------ | ------------------ |
| heading | 否 | `string \| boolean` | 标题 | | | heading | 否 | `string \| boolean` | 标题 | |
| text | 是 | `string \| string[]` | 文字内容 | | | text | 是 | `string \| string[]` | 文字内容 | |
| type | 否 | `'tip' \| 'warn' \| 'danger' \| 'info' \| 'none'` | 文字块样式 | 默认为 `'none'` | | type | 否 | `'tip' \| 'warn' \| 'danger' \| 'info' \| 'none'` | 文字块样式 | 默认为 `'none'` |
| align | 否 | `'left' \| 'right' \| 'center' \| 'justify'` | 段落对齐方式 | 默认为 `'justify'` | | align | 否 | `'left' \| 'right' \| 'center' \| 'justify'` | 段落对齐方式 | 默认为 `'justify'` |
| style | 否 | `string \| Record<string, string>` | 段落文字样式 | 填入 css 样式，会对段落的默认样式进行覆盖，该样式不会影响到标题 |
| 高级参数 | 必填 | 值类型 | 内容 | 备注 |
| -------- | :--: | :--------------------------------: | ------------ | --------------------------------------------------------------- |
| style | 否 | `string \| Record<string, string>` | 段落文字样式 | 填入 css 样式，会对段落的默认样式进行覆盖，该样式不会影响到标题 |
## p ## p
段落，可设置标题与样式 段落，可设置标题与样式
| 参数 | 必填 | 值类型 | 内容 | 备注 | | 参数 | 必填 | 值类型 | 内容 | 备注 |
| ------- | :--: | :------------------------------------------: | -------------- | --------------------------------------------------------------- | | ------- | :--: | :------------------------------------------: | -------------- | -------------------- |
| heading | 否 | `string \| boolean` | 标题 | | | heading | 否 | `string \| boolean` | 标题 | |
| text | 是 | `string \| string[]` | 段落文字内容 | | | text | 是 | `string \| string[]` | 段落文字内容 | |
| type | 否 | `'tip' \| 'warn' \| 'danger' \| 'info'` | 文字块样式 | 不填无额外样式 | | type | 否 | `'tip' \| 'warn' \| 'danger' \| 'info'` | 文字块样式 | 不填无额外样式 |
| path | 否 | `string` | 对应页面的路径 | 仅设置 `type` 时可用 | | path | 否 | `string` | 对应页面的路径 | 仅设置 `type` 时可用 |
| align | 否 | `'left' \| 'right' \| 'center' \| 'justify'` | 段落对齐方式 | 默认为 `'justify'` | | align | 否 | `'left' \| 'right' \| 'center' \| 'justify'` | 段落对齐方式 | 默认为 `'justify'` |
| style | 否 | `string \| Record<string, string>` | 段落文字样式 | 填入 css 样式，会对段落的默认样式进行覆盖，该样式不会影响到标题 |
| 高级参数 | 必填 | 值类型 | 内容 | 备注 |
| -------- | :--: | :--------------------------------: | ------------ | --------------------------------------------------------------- |
| style | 否 | `string \| Record<string, string>` | 段落文字样式 | 填入 css 样式，会对段落的默认样式进行覆盖，该样式不会影响到标题 |
## ul ## ul
无序列表，可设置标题与样式 无序列表，可设置标题与样式
| 参数 | 必填 | 值类型 | 内容 | 备注 | | 参数 | 必填 | 值类型 | 内容 | 备注 |
| ------- | :--: | :------------------------------------------: | ------------------ | --------------------------------------------------------------- | | ------- | :--: | :------------------------------------------: | ------------------ | -------------------- |
| heading | 否 | `string \| boolean` | 标题 | | | heading | 否 | `string \| boolean` | 标题 | |
| text | 是 | `string \| string[]` | 无序列表项文字内容 | | | text | 是 | `string \| string[]` | 无序列表项文字内容 | |
| type | 否 | `'tip' \| 'warn' \| 'danger' \| 'info'` | 文字块样式 | 不填无额外样式 | | type | 否 | `'tip' \| 'warn' \| 'danger' \| 'info'` | 文字块样式 | 不填无额外样式 |
| path | 否 | `string` | 对应页面的路径 | 仅设置 `type` 时可用 | | path | 否 | `string` | 对应页面的路径 | 仅设置 `type` 时可用 |
| align | 否 | `'left' \| 'right' \| 'center' \| 'justify'` | 段落对齐方式 | 默认为 `'justify'` | | align | 否 | `'left' \| 'right' \| 'center' \| 'justify'` | 段落对齐方式 | 默认为 `'justify'` |
| style | 否 | `string \| Record<string, string>` | 段落文字样式 | 填入 css 样式，会对段落的默认样式进行覆盖，该样式不会影响到标题 |
| 高级参数 | 必填 | 值类型 | 内容 | 备注 |
| -------- | :--: | :--------------------------------: | ------------ | --------------------------------------------------------------- |
| style | 否 | `string \| Record<string, string>` | 段落文字样式 | 填入 css 样式，会对段落的默认样式进行覆盖，该样式不会影响到标题 |
## ol ## ol
有序列表，可设置标题与样式 有序列表，可设置标题与样式
| 参数 | 必填 | 值类型 | 内容 | 备注 | | 参数 | 必填 | 值类型 | 内容 | 备注 |
| ------- | :--: | :------------------------------------------: | ------------------ | --------------------------------------------------------------- | | ------- | :--: | :------------------------------------------: | ------------------ | -------------------- |
| heading | 否 | `string \| boolean` | 标题 | | | heading | 否 | `string \| boolean` | 标题 | |
| text | 是 | `string \| string[]` | 有序列表项文字内容 | | | text | 是 | `string \| string[]` | 有序列表项文字内容 | |
| type | 否 | `'tip' \| 'warn' \| 'danger' \| 'info'` | 文字块样式 | 不填无额外样式 | | type | 否 | `'tip' \| 'warn' \| 'danger' \| 'info'` | 文字块样式 | 不填无额外样式 |
| path | 否 | `string` | 对应页面的路径 | 仅设置 `type` 时可用 | | path | 否 | `string` | 对应页面的路径 | 仅设置 `type` 时可用 |
| align | 否 | `'left' \| 'right' \| 'center' \| 'justify'` | 段落对齐方式 | 默认为 `'justify'` | | align | 否 | `'left' \| 'right' \| 'center' \| 'justify'` | 段落对齐方式 | 默认为 `'justify'` |
| style | 否 | `string \| Record<string, string>` | 段落文字样式 | 填入 css 样式，会对段落的默认样式进行覆盖，该样式不会影响到标题 |
| 高级参数 | 必填 | 值类型 | 内容 | 备注 |
| -------- | :--: | :--------------------------------: | ------------ | --------------------------------------------------------------- |
| style | 否 | `string \| Record<string, string>` | 段落文字样式 | 填入 css 样式，会对段落的默认样式进行覆盖，该样式不会影响到标题 |
## list ## list
带有跳转功能的列表，列表项可包含文字、图标、描述 带有跳转功能的列表，列表项可包含文字、图标、描述
| 参数 | 必填 | 值类型 | 内容 | 备注 | | 参数 | 必填 | 值类型 | 内容 | 备注 |
| ------- | :--: | :-----------------: | -------- | --------------------------------------------------------- | | ------ | :--: | :-----------------: | -------- | --------------------------------------------------------- |
| header | 否 | `string \| boolean` | 头部标题 | 不填会在标题所在处留空占位，设置为 `false` 来取消留空占位 | | header | 否 | `string \| boolean` | 头部标题 | 不填会在标题所在处留空占位，设置为 `false` 来取消留空占位 |
| footer | 否 | `string` | 尾部标题 | | | footer | 否 | `string` | 尾部标题 | |
| content | 是 | `SimpleList[]` | 列表内容 | | | items | 是 | `SimpleList[]` | 列表内容 | |
列表每一项参数如下: 列表每一项参数如下:
### 通用参数 ### 通用参数
| 参数 | 必填 | 值类型 | 内容 | | 参数 | 必填 | 值类型 | 内容 |
| ------ | :--: | :-------: | ---------------------------- | | ---- | :--: | :------: | ------------------------ |
| icon | 否 | `string` | 列表图标的简称或在线网址 | | icon | 否 | `string` | 列表图标的简称或在线网址 |
| text | 是 | `string` | 列表项文字 | | text | 是 | `string` | 列表项文字 |
| desc | 否 | `string` | 列表项描述，显示在尾部 | | desc | 否 | `string` | 列表项描述，显示在尾部 |
| hidden | 否 | `boolean` | 设置为 `true` 时隐藏该列表项 |
- 指向配置文件页面 - 指向配置文件页面
...@@ -317,24 +328,24 @@ carousel 组件默认高度为 400rpx，可以通过 style 属性调节 ...@@ -317,24 +328,24 @@ carousel 组件默认高度为 400rpx，可以通过 style 属性调节
九宫格组件，用于分类展示与跳转 九宫格组件，用于分类展示与跳转
| 参数 | 必填 | 值类型 | 内容 | | 参数 | 必填 | 值类型 | 内容 |
| ------- | :--: | :----------: | -------------------------------- | | ------ | :--: | :----------: | -------------------------------- |
| header | 否 | `string` | 九宫格的标题文字 | | header | 否 | `string` | 九宫格的标题文字 |
| footer | 否 | `string` | 九宫格的尾部文字 | | footer | 否 | `string` | 九宫格的尾部文字 |
| content | 是 | `GridItem[]` | 该数组的每个元素均为一个格子内容 | | items | 是 | `GridItem[]` | 该数组的每个元素均为一个格子内容 |
### GridItem ### GridItem
九宫格项目配置 九宫格项目配置
| 参数 | 必填 | 值类型 | 内容 | | 参数 | 必填 | 值类型 | 内容 |
| ----- | :--: | :-----------------------------------------------------------------------: | ------------------------------------------------------------------- | | ----- | :--: | :---------------------------------------------------------------------------------: | ------------------------------------------------------------------- |
| icon | 是 | `string` | 九宫格的图标的简称或在线网址 | | icon | 是 | `string` | 九宫格的图标的简称或在线网址 |
| text | 是 | `string` | 九宫格文字 | | text | 是 | `string` | 九宫格文字 |
| color | 是 | `'blue' \| 'orange' \| 'red' \| 'purple' \| 'cyan' \| 'olive' \| 'mauve'` | Android 主题下的颜色 | | color | 是 | `'blue' \| 'orange' \| 'red' \| 'purple' \| 'cyan' \| 'olive' \| 'mauve' \| 'grey'` | Android 主题下的颜色 |
| name | 是 | `string` | 对应的英文文字 | | name | 是 | `string` | 对应的英文文字 |
| path | 否 | `string` | 对应配置文件的相对或绝对路径(不带后缀名)，以 `/` 结尾默认为 `index` | | path | 否 | `string` | 对应配置文件的相对或绝对路径(不带后缀名)，以 `/` 结尾默认为 `index` |
| url | 否 | `string` | 列表指向的界面路径或短名称，可带参数 | | url | 否 | `string` | 列表指向的界面路径或短名称，可带参数 |
## media ## media
......
src/note/innenu/get-started.md
浏览文件 @ c08cef17
...@@ -58,15 +58,19 @@ category: 小程序 ...@@ -58,15 +58,19 @@ category: 小程序
::: details 总体结构 ::: details 总体结构
| 参数 | 必填 | 值类型 | 内容 | 备注 | | 参数 | 必填 | 值类型 | 内容 | 备注 |
| --------- | :--: | :-----------------: | ------------ | -------------------------------------------- | | --------- | :--: | :------------------: | ------------------ | ----------------------------------------------- |
| title | 是 | `string` | 导航栏标题 | 一般不超过八个字，六字及以下为佳 | | title | 是 | `string` | 导航栏标题 | 一般不超过八个字，六字及以下为佳 |
| desc | 否 | `string` | 页面描述 | 会显示在页脚 | | desc | 否 | `string` | 页面描述 | 会显示在页脚 |
| author | 否 | `string` | 页面的作者 | 会显示在页脚 | | author | 否 | `string` | 页面的作者 | 会显示在页脚 |
| time | 否 | `string` | 页面更新时间 | 会显示在页脚 | | time | 否 | `string` | 页面更新时间 | 会显示在页脚 |
| grey | 否 | `boolean` | 使用灰色背景 | 默认为白色背景 | | grey | 否 | `boolean` | 使用灰色背景 | 默认为白色背景 |
| content | 否 | `ComponentConfig[]` | 页面的内容 | 数组的每个对象会最终渲染为一个组件 | | cite | 否 | `string \| string[]` | 页面引用链接 | |
| shareable | 否 | `boolean` | 是否可被分享 | 是否可以使用小程序的界面分享，默认为 `false` | | content | 否 | `ComponentConfig[]` | 页面的内容 | 数组的每个对象会最终渲染为一个组件 |
| from | 否 | `string` | 左上角返回按钮文字 | 设置左上角文字，默认为上一级页面标题 |
| outdated | 否 | `boolean` | 是否已过时 | 可展示一条“页面过时”提示 |
| shareable | 否 | `boolean` | 是否可被分享 | 是否可以使用小程序的界面分享，默认为 `false` |
| contact | 否 | `boolean` | “联系开发者”按钮 | 是否在分享菜单中显示“联系开发者”，默认为 `true` |
::: :::
...@@ -235,8 +239,8 @@ content: ...@@ -235,8 +239,8 @@ content:
in 东师服务器文件结构如下: in 东师服务器文件结构如下:
- 文件: 存放在 `https://mp.innenu.com/file/` - 文件: 存放在 `https://mp.innenu.com/file/`，可以用 `$file` 索引
- 图片: 存放在 `https://mp.innenu.com/img/` - 图片: 存放在 `https://mp.innenu.com/img/`，可以用 `$img` 索引
- 页面 YAML: 存放在 `https://mp.innenu.com/res/` - 页面 YAML: 存放在 `https://mp.innenu.com/res/`
- 图标: 存放在 `https://mp.innenu.com/res/icon/` - 图标: 存放在 `https://mp.innenu.com/res/icon/`
...@@ -254,9 +258,9 @@ in 东师服务器文件结构如下: ...@@ -254,9 +258,9 @@ in 东师服务器文件结构如下:
同时，您需要在对应的配置项填入: 同时，您需要在对应的配置项填入:
- `https://mp.innenu.com/img/account/authserver.jpg` - `$img/account/authserver.jpg`
- `https://mp.innenu.com/img/account/reset-password.jpg` - `$img/account/reset-password.jpg`
- `https://mp.innenu.com/img/account/email-address.jpg` - `$img/account/email-address.jpg`
提交时，直接提交下列压缩包结构。 提交时，直接提交下列压缩包结构。
...@@ -305,7 +309,7 @@ content: ...@@ -305,7 +309,7 @@ content:
- 邮箱地址统一为 “别名” + “@nenu.edu.cn” - 邮箱地址统一为 “别名” + “@nenu.edu.cn”
- tag: img - tag: img
src: https://mp.innenu.com/img/account/email-address.jpg src: $img/account/email-address.jpg
desc: 本例中邮箱为 "mr-hope@nenu.edu.cn" desc: 本例中邮箱为 "mr-hope@nenu.edu.cn"
- tag: text - tag: text
...@@ -314,7 +318,7 @@ content: ...@@ -314,7 +318,7 @@ content:
text: Nenu + 身份证后六位，X 用 1 代替 text: Nenu + 身份证后六位，X 用 1 代替
- tag: img - tag: img
src: https://mp.innenu.com/img/account/authserver.jpg src: $img/account/authserver.jpg
- tag: title - tag: title
text: 修改密码及密保绑定 text: 修改密码及密保绑定
...@@ -329,7 +333,7 @@ content: ...@@ -329,7 +333,7 @@ content:
text: 点击“修改密码”，修改初始密码。 text: 点击“修改密码”，修改初始密码。
- tag: img - tag: img
src: https://mp.innenu.com/img/account/reset-password.jpg src: $img/account/reset-password.jpg
- tag: ul - tag: ul
type: tip type: tip
...@@ -347,15 +351,15 @@ content: ...@@ -347,15 +351,15 @@ content:
如果您同时提交了多个文件，或者您编写的页面想要导航至其他页面，您就需要创建列表来构建“页面跳转”。 如果您同时提交了多个文件，或者您编写的页面想要导航至其他页面，您就需要创建列表来构建“页面跳转”。
列表组件因为含有多个子项目，其 `content` 属性的值和文件的根键值 `content` 很像。您需要为数组中的每个元素设置文字与可选的图标、描述和链接。 列表组件因为含有多个子项目，其 `items` 属性的值和文件的根键值 `content` 很像。您需要为数组中的每个元素设置文字与可选的图标、描述和链接。
::: details 列表参数 ::: details 列表参数
| 参数 | 必填 | 值类型 | 内容 | 备注 | | 参数 | 必填 | 值类型 | 内容 | 备注 |
| ------- | :--: | :-------------------: | -------- | --------------------------------------------------------- | | ------ | :--: | :-------------------: | -------- | --------------------------------------------------------- |
| header | 否 | `string` \| `boolean` | 头部标题 | 不填会在标题所在处留空占位，设置为 `false` 来取消留空占位 | | header | 否 | `string` \| `boolean` | 头部标题 | 不填会在标题所在处留空占位，设置为 `false` 来取消留空占位 |
| footer | 否 | `string` | 尾部标题 | | | footer | 否 | `string` | 尾部标题 | |
| content | 是 | `SimpleList[]` | 列表内容 | | | items | 是 | `SimpleList[]` | 列表内容 | |
列表每一项参数如下: 列表每一项参数如下:
...@@ -392,12 +396,12 @@ title: 账号 ...@@ -392,12 +396,12 @@ title: 账号
content: content:
- tag: list - tag: list
header: 了解更多 header: 了解更多
content: items:
- text: 统一身份认证 - text: 统一身份认证
- tag: list - tag: list
header: 校园邮箱 header: 校园邮箱
content: items:
- text: 邮箱介绍 - text: 邮箱介绍
- text: 安卓邮箱客户端设置 - text: 安卓邮箱客户端设置
...@@ -412,13 +416,13 @@ title: 账号 ...@@ -412,13 +416,13 @@ title: 账号
content: content:
- tag: list - tag: list
header: 了解更多 header: 了解更多
content: items:
- text: 统一身份认证 - text: 统一身份认证
icon: authorize icon: authorize
- tag: list - tag: list
header: 校园邮箱 header: 校园邮箱
content: items:
- text: 邮箱介绍 - text: 邮箱介绍
icon: email icon: email
...@@ -436,14 +440,14 @@ title: 账号 ...@@ -436,14 +440,14 @@ title: 账号
content: content:
- tag: list - tag: list
header: 了解更多 header: 了解更多
content: items:
- text: 统一身份认证 - text: 统一身份认证
icon: authorize icon: authorize
path: authorize path: authorize
- tag: list - tag: list
header: 校园邮箱 header: 校园邮箱
content: items:
- text: 邮箱介绍 - text: 邮箱介绍
icon: email icon: email
path: mail/intro path: mail/intro
...@@ -468,16 +472,16 @@ content: ...@@ -468,16 +472,16 @@ content:
``` ```
└─ res └─ res
├─ intro ├─ intro
| ... | ...
└─ guide └─ guide
└─ account └─ account
├─ mail ├─ mail
| ├─ intro.yml (邮箱介绍) | ├─ intro.yml (邮箱介绍)
| ├─ ios.yml (iOS 邮箱设置) | ├─ ios.yml (iOS 邮箱设置)
| └─ android.yml (安卓邮箱设置) | └─ android.yml (安卓邮箱设置)
| |
├─ authorize.yml (统一身份认证) ├─ authorize.yml (统一身份认证)
└─ index.yml (账号主页) └─ index.yml (账号主页)
``` ```
比如，对于所有文件来说，他们都可以通过 `/guide/account/mail/intro` 访问 `intro.yml`。 比如，对于所有文件来说，他们都可以通过 `/guide/account/mail/intro` 访问 `intro.yml`。
......
src/note/innenu/tag-list.md
浏览文件 @ c08cef17
此差异已折叠。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或