Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Documentation. #730

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve Documentation. #730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ English | [简体中文](./README-zh.md)
**Live demo:** http://panjiachen.github.io/vue-admin-template


**The current version is `v4.0+` build on `vue-cli`. If you want to use the old version , you can switch branch to [tag/3.11.0](https://github.com/PanJiaChen/vue-admin-template/tree/tag/3.11.0), it does not rely on `vue-cli`**
**The current version is `v4.0+` build on `vue-cli`. If you want to use the old version, you can switch branch to [tag/3.11.0](https://github.com/PanJiaChen/vue-admin-template/tree/tag/3.11.0), it does not rely on `vue-cli`**

<p align="center">
<b>SPONSORED BY</b>
Expand All @@ -27,7 +27,7 @@ git clone https://github.com/PanJiaChen/vue-admin-template.git
# enter the project directory
cd vue-admin-template

# install dependency
# install dependencies
npm install

# develop
Expand Down Expand Up @@ -70,7 +70,7 @@ Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/gui

## Extra

If you want router permission && generate menu by user roles , you can use this branch [permission-control](https://github.com/PanJiaChen/vue-admin-template/tree/permission-control)
If you want router permission && generate menu by user roles, you can use this branch [permission-control](https://github.com/PanJiaChen/vue-admin-template/tree/permission-control)

For `typescript` version, you can use [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template) (Credits: [@Armour](https://github.com/Armour))

Expand Down
22 changes: 11 additions & 11 deletions src/router/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@ Vue.use(Router)
import Layout from '@/layout'

/**
* Note: sub-menu only appear when route children.length >= 1
* Note: sub-menu only appears when route children.length >= 1
* Detail see: https://panjiachen.github.io/vue-element-admin-site/guide/essentials/router-and-nav.html
*
* hidden: true if set true, item will not show in the sidebar(default is false)
* alwaysShow: true if set true, will always show the root menu
* if not set alwaysShow, when item has more than one children route,
* it will becomes nested mode, otherwise not show the root menu
* redirect: noRedirect if set noRedirect will no redirect in the breadcrumb
* name:'router-name' the name is used by <keep-alive> (must set!!!)
* hidden: true if set to true, item will not show in the sidebar (default is false)
* alwaysShow: true if set to true, will always show the root menu
* if not set to true, when item has more than one child route,
* it will become nested mode, otherwise not show the root menu
* redirect: noRedirect if set to noRedirect, it will not redirect in the breadcrumb
* name:'router-name' the name is used by <keep-alive> (must set!!!)
* meta : {
roles: ['admin','editor'] control the page roles (you can set multiple roles)
title: 'title' the name show in sidebar and breadcrumb (recommend set)
icon: 'svg-name'/'el-icon-x' the icon show in the sidebar
breadcrumb: false if set false, the item will hidden in breadcrumb(default is true)
activeMenu: '/example/list' if set path, the sidebar will highlight the path you set
title: 'title' the name to show in sidebar and breadcrumb (recommended to set)
icon: 'svg-name'/'el-icon-x' the icon to show in the sidebar
breadcrumb: false if set to false, the item will be hidden in breadcrumb (default is true)
activeMenu: '/example/list' if path is set, the sidebar will highlight the path you set
}
*/

Expand Down