研发图纸文件管理系统-前端项目
iczer
2020-07-23 ebb9d19ccda7407ba8d0150a7c5006be4a45c1c4
chore: update document; :star2:
5个文件已修改
40 ■■■■■ 已修改文件
docs/develop/layout.md 2 ●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/develop/page.md 10 ●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/develop/router.md 9 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/develop/theme.md 4 ●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/start/use.md 15 ●●●●● 补丁 | 查看 | 原始文档 | blame | 历史
docs/develop/layout.md
@@ -29,7 +29,7 @@
![blank-view](../assets/blank-view.png)
## 如何使用
通常我们会把视图组件和路由配置结合一起使用,我们把配置信息抽离在路由配置文件中 [router/index.js](https://github.com/iczer/vue-antd-admin/blob/master/src/router/index.js) 。如下:
通常我们会把视图组件和路由配置结合一起使用,我们把配置信息抽离在路由配置文件中 [src/router/config.js](https://github.com/iczer/vue-antd-admin/blob/master/src/router/config.js) 。如下:
```jsx {7,12}
{
  path: 'form',
docs/develop/page.md
@@ -67,9 +67,9 @@
export default NewPage
```
## 配置路由
路由配置在 src/router/index.js 文件中,我们把上面创建的页面文件加入路由配置中
路由配置在 src/router/config.js 文件中,我们把上面创建的页面文件加入路由配置中
```js {10-14}
const router =  new Router({
const options = {
  routes: [
    {name: '登录页'...},
    {
@@ -96,7 +96,7 @@
      ...
    }
  ]
})
}
```
:::tip
我们建议使用英文设置路由的 path 属性,用中文设置路由的 name 属性。因为系统将自动提取路由的 path 和 name 属性作为国际化配置。这在后面的章节
@@ -108,7 +108,7 @@
如果你想把它配置为二级页面或更深层级的页面,只需为它配置一个父级路由,并为父级路由配置一个[视图组件](./layout.md#admin-的视图),
这里我们选择 [PageView](https://github.com/iczer/vue-antd-admin/blob/master/src/layouts/PageView.vue),如下:
```js {10-21}
const router =  new Router({
const options = {
  routes: [
    {name: '登录页'...},
    {
@@ -134,7 +134,7 @@
      ...
    }
  ]
})
}
```
:::warning
页面所有父级路由的组件必须配置为[视图组件](../develop/layout.md#admin-的视图),否则页面的内容可能不会显示。  
docs/develop/router.md
@@ -17,9 +17,8 @@
## 路由
Vue Antd Admin 的路由配置完全遵循 vue-router 的 [routes 配置规则](https://router.vuejs.org/zh/api/#routes)。
另外我们还在 routes 的元数据属性 [meta](https://router.vuejs.org/zh/guide/advanced/meta.html#%E8%B7%AF%E7%94%B1%E5%85%83%E4%BF%A1%E6%81%AF) 中注入了三个属性 icon、invisible 和 page,它们将在生成菜单和页头时发挥作用。配置示例如下:
```js {8,14}
import Router from 'vue-router'
export default new Router({
```js {7,13}
const options = {
  routes: [{
    path: '/',
    name: '首页',
@@ -45,9 +44,9 @@
      }]
    }]
  }]
})
}
```
完整配置示例,请查看 [router/index.js](https://github.com/iczer/vue-antd-admin/blob/master/src/router/index.js)
完整配置示例,请查看 [src/router/config.js](https://github.com/iczer/vue-antd-admin/blob/master/src/router/config.js)
## 菜单
Admin 系统的菜单直接通过路由配置生成,路由属性和菜单功能对应关系如下
docs/develop/theme.md
@@ -482,7 +482,7 @@
```
### 多页签
在 src/config/config.js 设置 multiPage 来启用或关闭多页签模式
```js {7}
```js {6}
module.exports = {
  theme: {
    color: '#13c2c2',
@@ -499,4 +499,4 @@
:::tip
以上所有主题设置项,均已映射到 vuex/setting 模块的 state 中,你可以通过提交 setting/mutations 实时修改设置项。  
如何使用 [mutations](https://vuex.vuejs.org/zh/guide/mutations.html) ?
:::
:::
docs/start/use.md
@@ -13,7 +13,17 @@
安装依赖
```bash
$ yarn install
or
$ npm install
```
:::tip
master 分支是 Vue Antd Admin 的标准版代码,此分支代码适合用于用于学习研究,不推荐在此分支做正式开发。
我们在 basic 分支提供了 Vue Antd Admin 的基础版代码,正式开发请切换至此分支,以便于后续的版本更新。
:::
:::warning
如果基于 `master分支` 进行开发,在版本更新时遇到的代码冲突问题请自行解决,我们不对基于 `master分支` 开发时遇到的问题提供技术支持。
再次强调,`master分支` 仅推荐用于学习参考,正式开发请切换至 `basic` 分支!!!
:::
## 目录结构
我们已经为你生成了一个完整的开发框架,提供了涵盖中后台开发的各类功能和坑位,下面是整个项目的目录结构。
@@ -24,13 +34,14 @@
│   └── index.html           # 入口 HTML
├── src
│   ├── assets               # 本地静态资源
│   ├── components           # 业务通用组件
│   ├── components           # 内置通用组件
│   ├── config               # 系统配置
│   ├── layouts              # 通用布局
│   ├── mock                 # 本地 mock 数据
│   ├── pages                # 页面组件和通用模板
│   ├── plugins              # vue 插件
│   ├── router               # 路由配置
│   ├── services             # 数据服务模块
│   ├── store                # vuex 状态管理配置
│   ├── theme                # 主题相关
│   ├── utils                # js 工具
@@ -44,5 +55,7 @@
启动服务
```bash
$ yarn serve
or
$ npm run serve
```
启动成功后,会看到一个本地预览地址,通常是 http://localhost:8080 。接下来就可以修改代码,并实时预览修改结果啦!