Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaoxian521 committed May 28, 2024
1 parent bf40ea3 commit 46bb5a9
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 16 deletions.
Binary file added docs/.vuepress/public/img/layout/double.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.vuepress/public/img/layout/horizontal.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.vuepress/public/img/layout/mixNav.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.vuepress/public/img/layout/vertical.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/01.指南/01.指南/02.快速开始.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ permalink: /pages/start

## 开发环境

`vue-pure-admin v5.0.0` 版本后,规定 `node` 版本应不小于 `18.18.0` (推荐优先安装长期维护`LTS`版,如下图),`pnpm` 版本应不小于 `8.6.10`
`vue-pure-admin v5.0.0` 版本后,规定 `node` 版本应不小于 `18.18.0` (推荐优先安装长期维护`LTS`版,如下图),`pnpm` 版本应不小于 `9`

[nodejs 官网](https://nodejs.org/en) 当然也可以安装 [.nvmrc](https://gitee.com/yiming_chang/vue-pure-admin/blob/main/.nvmrc#L1) 推荐的 `node` 版本

Expand Down
4 changes: 2 additions & 2 deletions docs/01.指南/01.指南/05.平台配置.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ permalink: /pages/config/

![config-logo](~@alias/img/guide/config-logo.jpg)

当然也可以自定义 `logo` 格式。比如需要 `png` 的图片,只需要把上图中 `logo.svg` 换成所需的 `logo.png` ,然后来到 [layout/hooks/useNav.ts](https://gitee.com/yiming_chang/vue-pure-admin/blob/main/src/layout/hooks/useNav.ts#L133) ,把 `"/logo.svg"` 改成 `"/logo.png"` 即可
当然也可以自定义 `logo` 格式。比如需要 `png` 的图片,只需要把上图中 `logo.svg` 换成所需的 `logo.png` ,然后来到 [layout/hooks/useNav.ts](https://gitee.com/yiming_chang/vue-pure-admin/blob/main/src/layout/hooks/useNav.ts#L147) ,把 `"/logo.svg"` 改成 `"/logo.png"` 即可

## 环境变量

Expand Down Expand Up @@ -109,7 +109,7 @@ const ret: ViteEnv = {
"MultiTagsCache": false, // 是否开启持久化标签 (会缓存)
"KeepAlive": true, // 是否开启组件缓存(此处不同于路由的 keepAlive,如果此处为 true 表示设置路由的 keepAlive 起效,反之设置 false 屏蔽平台整体的 keepAlive,即使路由设置了keepAlive 也不再起作用)
"Locale": "zh", // 默认国际化语言 (zh 中文、en 英文)(会缓存)
"Layout": "vertical", // 导航菜单模式 (vertical 左侧菜单模式、horizontal 顶部菜单模式、mix 综合菜单模式)(会缓存)
"Layout": "vertical", // 导航菜单模式 (vertical 左侧菜单模式、horizontal 顶部菜单模式、mix 混合菜单模式、double 左侧双栏菜单模式)(会缓存)
"Theme": "light", // 主题模式(会缓存)
"DarkMode": false, // 是否开启暗黑模式 (会缓存)
"OverallStyle": "light", // 整体风格(浅色:light、深色:dark、自动:system)(会缓存)更多详情看 https://github.com/pure-admin/vue-pure-admin/commit/dd783136229da9e291b518df93227111f4216ad0#commitcomment-137027417
Expand Down
14 changes: 5 additions & 9 deletions docs/01.指南/01.指南/06.布局.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ permalink: /pages/layout/

::: details 查看介绍

[代码实现](https://gitee.com/yiming_chang/vue-pure-admin/blob/main/src/layout/components/sidebar/vertical.vue)

![vertical-detail](~@alias/img/layout/vertical-detail.jpg)

:::
Expand All @@ -23,24 +21,22 @@ permalink: /pages/layout/

::: details 查看介绍

[代码实现](https://gitee.com/yiming_chang/vue-pure-admin/blob/main/src/layout/components/sidebar/horizontal.vue)

![horizontal-detail](~@alias/img/layout/horizontal-detail.jpg)

:::

## 综合菜单模式
## 混合菜单模式

![mixNav](~@alias/img/layout/mixNav.jpg)

::: details 查看介绍

[代码实现](https://gitee.com/yiming_chang/vue-pure-admin/blob/main/src/layout/components/sidebar/mixNav.vue)

![mixNav-detail](~@alias/img/layout/mixNav-detail.jpg)

:::

## 左侧双栏模式
## 双栏菜单模式

[仅高级版拥有](https://github.com/pure-admin/vue-pure-admin-max?tab=readme-ov-file#vue-pure-admin-max-%E4%B8%8E-vue-pure-admin-%E7%9A%84%E5%8C%BA%E5%88%AB%E6%98%AF%E5%A6%82%E4%BD%95%E6%8B%A5%E6%9C%89-max-%E7%89%88%E6%9C%AC)

[计划中](https://github.com/pure-admin/vue-pure-admin/issues/897)
![mixNav](~@alias/img/layout/double.jpg)
2 changes: 1 addition & 1 deletion docs/01.指南/02.进阶/02.主题和暗黑模式.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ permalink: /pages/theme/
subMenuActiveText;
// 菜单未激活时的整体背景色
menuBg;
// 顶部、综合菜单模式下最右上角 搜索、告警、用户名、设置鼠标覆盖后的背景色
// 顶部、混合菜单模式下最右上角 搜索、告警、用户名、设置鼠标覆盖后的背景色
menuHover;
// 子菜单未激活时的背景色
subMenuBg;
Expand Down
4 changes: 2 additions & 2 deletions docs/01.指南/04.其他/01.常见问题.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ permalink: /pages/FAQ/

![error](~@alias/img/guide/error1.png)

- 解决办法:请遵循平台要求,安装对应的 `node``pnpm` 版本 ( `node` 16 版本及以上、`pnpm` 6 版本及以上)
- 解决办法:请遵循平台要求,安装对应的 `node``pnpm` 版本 ( `node` 18.18.0 版本及以上、`pnpm` 9 版本及以上)

## 安装依赖时出现报错 `Cannot find module 'sass'`

Expand Down Expand Up @@ -182,7 +182,7 @@ defineOptions({
- 如何避免?
答:可以在 [此处](https://gitee.com/yiming_chang/vue-pure-admin/blob/main/public/platform-config.json#L25) 修改 `ResponsiveStorageNameSpace` 为您所需的命名空间即可

## 平台要求 `node` 版本应不小于 `18.18.0``pnpm` 版本应不小于 `8.6.10` ,但是实际开发有的项目需要比这些低的版本怎么解决呢?
## 平台要求 `node` 版本应不小于 `18.18.0``pnpm` 版本应不小于 `9` ,但是实际开发有的项目需要比这些低的版本怎么解决呢?

答:推荐阅读 [三款非常实用的 Node.js 版本管理工具](https://blog.csdn.net/qq_36380426/article/details/126218495)

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ features: # 可选的
- title: 👋 提供精简版永久同步完整版代码
details: 提供国际化和非国际化两种精简版本,开启brotli压缩和cdn替换本地库模式后,打包大小低于350kb
- title: 🔩 高度可配置主题和三种菜单布局
details: 高度可配置的主题以及暗黑主题适配,并且提供左侧、顶部、综合这三种菜单布局模式
details: 高度可配置的主题以及暗黑主题适配,并且提供左侧、顶部、混合、双栏这四种菜单布局模式
- title: 🔑 RBAC权限管理可控粒度的权限
details: 采用目前最常用的 RBAC 基于角色的权限控制( 用户 -> 角色 -> 权限 ),可配置各种粒度的权限

Expand Down

0 comments on commit 46bb5a9

Please sign in to comment.